SessionContextInterfaceForDialogTracker Class Reference

#include <SessionContext.h>

Inheritance diagram for SessionContextInterfaceForDialogTracker:

List of all members.

Public Member Functions
virtual bool	doesEndpointsLocationImposeMediaRelay (void) const =0
	Determines whether or not a media relay needs to be employed in the media session between the caller and the callee baed o ntheir relative location in the network.
virtual bool	allocateMediaRelaySession (const UtlString &handleOfRequestingDialogContext, tMediaRelayHandle &relayHandle, int &callerRelayRtpPort, int &calleeRelayRtpPort)=0
	Requests the allocation of a media relay session on the Smmitron.
virtual tMediaRelayHandle	cloneMediaRelaySession (const UtlString &handleOfRequestingDialogContext, tMediaRelayHandle &relayHandleToClone, bool doSwapCallerAndCallee)=0
	Requests the cloning of an existing media relay session.
virtual bool	deallocateMediaRelaySession (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle)=0
	Requests the de-allocation of a previously allocated media relay session.
virtual int	getRtpRelayPortForMediaRelaySession (const tMediaRelayHandle &handle, EndpointRole endpointRole)=0
	Used to query the RTP port that a given MediaRelaySession has allocated to the endpoint whose role is passed as a parameter.
virtual void	reportDialogTrackerReadyForDeletion (const UtlString &handleOfRequestingDialogContext)=0
	Used to notify the owning SessionContext that the dialog a DialogTracker non longer needs to be tracked and that the DialogTracker object is redy for deletion.
virtual bool	setMediaRelayDirectionMode (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle, MediaDirectionality mediaRelayDirectionMode, EndpointRole endpointRole)=0
	Configures the directionality of the media relay.
virtual bool	linkFarEndMediaRelayPortToRequester (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle, const MediaDescriptor *pMediaDescriptor, EndpointRole endpointRoleOfRequester)=0
	Establishes the requester as the media destination for the far-end's media relay port.
virtual bool	getMediaRelayAddressToUseInSdp (UtlString &mediaRelayAddressToUse, EndpointRole endpointRole) const =0
	Computes the media relay IP address to use when patching SDP originating from endpoint designated by endpointRole param.
virtual bool	getPacketProcessingStatsForMediaRelaySession (const tMediaRelayHandle &handle, PacketProcessingStatistics &stats)=0
	Retrieves the packet processing statistics for a given media relay session designated by its handle.
virtual	~SessionContextInterfaceForDialogTracker ()

---

Constructor & Destructor Documentation

virtual ~SessionContextInterfaceForDialogTracker

(

)

[inline, virtual]

---

Member Function Documentation

virtual bool doesEndpointsLocationImposeMediaRelay

(

void

)

const [pure virtual]

Determines whether or not a media relay needs to be employed in the media session between the caller and the callee baed o ntheir relative location in the network.

Implemented in SessionContext, and DialogTrackerTest.

virtual bool allocateMediaRelaySession	(	const UtlString &	handleOfRequestingDialogContext,
		tMediaRelayHandle &	relayHandle,
		int &	callerRelayRtpPort,
		int &	calleeRelayRtpPort
	)			[pure virtual]

Requests the allocation of a media relay session on the Smmitron.

Parameters:

[in]	handleOfRequestingDialogContext	- what it says
[out]	relayHandle	- handle to allocated media relay session
[out]	callerRelayRtpPort	- RTP port representing caller on the Symmitron. This is the RTP port the callee will be asked to send its media to.
[out]	calleeRelayRtpPort	- RTP port representing callee on the Symmitron. This is the RTP port the caller will be asked to send its media to.

Returns:

- true media relay session was properly allocated.

Implemented in SessionContext, and DialogTrackerTest.

virtual tMediaRelayHandle cloneMediaRelaySession	(	const UtlString &	handleOfRequestingDialogContext,
		tMediaRelayHandle &	relayHandleToClone,
		bool	doSwapCallerAndCallee
	)			[pure virtual]

Requests the cloning of an existing media relay session.

This cloning technique is utilized in scenarios where multiple unrelated dialogs use the same media relay session. The best example of such a scenario is a 3PCC call such as MOH.

Parameters:

[in]	handleOfRequestingDialogContext	- what it says
[in]	relayHandleToClone	- handle of media relay session to clone
[in]	doSwapCallerAndCallee	- indicates whether or not the roles of the caller and callee need to be inverted in the cloned session.

Returns:

- handle of the clone media relay session

Implemented in SessionContext, and DialogTrackerTest.

virtual bool deallocateMediaRelaySession	(	const UtlString &	handleOfRequestingDialogContext,
		const tMediaRelayHandle &	relayHandle
	)			[pure virtual]

Requests the de-allocation of a previously allocated media relay session.

Parameters:

[in]	handleOfRequestingDialogContext	- what it says
[in]	relayHandle	- handle of media relay session to de-allocate

Returns:

- true media relay session was properly de-allocated.

Implemented in SessionContext, and DialogTrackerTest.

virtual int getRtpRelayPortForMediaRelaySession	(	const tMediaRelayHandle &	handle,
		EndpointRole	endpointRole
	)			[pure virtual]

Used to query the RTP port that a given MediaRelaySession has allocated to the endpoint whose role is passed as a parameter.

Parameters:

[in]

handle

- handle of media relay session to query ]param [in] endpointRole - role of endpoint for which to retrieve RTP port

Returns:

- PORT_NONE if failed, otherwise RTP port number

Implemented in SessionContext, and DialogTrackerTest.

virtual void reportDialogTrackerReadyForDeletion

(

const UtlString &

handleOfRequestingDialogContext

)

[pure virtual]

Used to notify the owning SessionContext that the dialog a DialogTracker non longer needs to be tracked and that the DialogTracker object is redy for deletion.

Parameters:

[in]

handleOfRequestingDialogContext

- what it says

Implemented in SessionContext, and DialogTrackerTest.

virtual bool setMediaRelayDirectionMode	(	const UtlString &	handleOfRequestingDialogContext,
		const tMediaRelayHandle &	relayHandle,
		MediaDirectionality	mediaRelayDirectionMode,
		EndpointRole	endpointRole
	)			[pure virtual]

Configures the directionality of the media relay.

Note that the directionality specified in the 'mediaRelayDirectionMode' parameter is referenced from the caller.

Parameters:

[in]	handleOfRequestingDialogContext	- what it says
[in]	relayHandle	- handle of media relay session on which to apply the direction mode
[in]	mediaRelayDirectionMode	- direction mode to apply to media relay session referenced to the originator of the request.
[in]	endpointRole	- role of the originator of the request.

Returns:

- indicates whether or not the direction was set successfully.

Implemented in SessionContext, and DialogTrackerTest.

virtual bool linkFarEndMediaRelayPortToRequester	(	const UtlString &	handleOfRequestingDialogContext,
		const tMediaRelayHandle &	relayHandle,
		const MediaDescriptor *	pMediaDescriptor,
		EndpointRole	endpointRoleOfRequester
	)			[pure virtual]

Establishes the requester as the media destination for the far-end's media relay port.

Parameters:

[in]	handleOfRequestingDialogContext	- what it says
[in]	relayHandle	- handle of media relay session to apply the change
[in]	pMediaDescriptor	- pointer descriptor containing information about the requestor
[in]	endpointRoleOfRequester	- role of requestor.

Returns:

- indicates whether or not the destination was set successfully.

Implemented in SessionContext, and DialogTrackerTest.

virtual bool getMediaRelayAddressToUseInSdp	(	UtlString &	mediaRelayAddressToUse,
		EndpointRole	endpointRole
	)			const [pure virtual]

Computes the media relay IP address to use when patching SDP originating from endpoint designated by endpointRole param.

Parameters:

[out]	mediaRelayAddressToUse	- will contain the Symmitron address to use when patching SDP
[in]	endpointRole	- role of endpoint making the request.

Returns:

true if media relay's native IP address is to be used. false if media relay's public IP address is to be used

Implemented in SessionContext, and DialogTrackerTest.

virtual bool getPacketProcessingStatsForMediaRelaySession	(	const tMediaRelayHandle &	handle,
		PacketProcessingStatistics &	stats
	)			[pure virtual]

Retrieves the packet processing statistics for a given media relay session designated by its handle.

Parameters:

[in]	handle	- handle of media relay session for which to obtain packet processing stats
[out]	stats	- structure that will receive the requested stats information

Returns:

true operation succeeds, false otherwise

Implemented in SessionContext, and DialogTrackerTest.