DialogTrackerTest Class Reference

Inheritance diagram for DialogTrackerTest:

List of all members.

Public Member Functions

DialogTrackerTest ()

bool doesEndpointsLocationImposeMediaRelay (void) const

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.

bool allocateMediaRelaySession (const UtlString &handleOfRequestingDialogContext, tMediaRelayHandle &relayHandle, int &callerRelayRtpPort, int &calleeRelayRtpPort)

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

tMediaRelayHandle cloneMediaRelaySession (const UtlString &handleOfRequestingDialogContext, tMediaRelayHandle &relayHandleToClone, bool doSwapCallerAndCallee)

Requests the cloning of an existing media relay session.

bool deallocateMediaRelaySession (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle)

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

bool setMediaRelayDirectionMode (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle, MediaDirectionality mediaRelayDirectionMode, EndpointRole endpointRole)

Configures the directionality of the media relay.

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

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

bool getMediaRelayAddressToUseInSdp (UtlString &mediaRelayAddressToUse, EndpointRole endpointRole) const

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

void reportDialogTrackerReadyForDeletion (const UtlString &handleOfRequestingDialogContext)

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.

int getRtpRelayPortForMediaRelaySession (const tMediaRelayHandle &handle, EndpointRole role)

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

bool getPacketProcessingStatsForMediaRelaySession (const tMediaRelayHandle &handle, PacketProcessingStatistics &stats)

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

void setUp ()

void tearDown ()

void timerTickCounterTest ()

void DialogEstablishedFlagManipsTest ()

void TransactionDirectionalityFlagManipsTest ()

void MediaRelayRequiredFlagManipsTest ()

void MediaDescriptorsManipsTest ()

void getOurMediaRelayHandleEncodedInSdpTest ()

void requestHandledMarkerManipTest ()

void RequestRetransmissionDescriptorTest ()

void ResponseRetransmissionDescriptorTest ()

void RemoveUnwantedElementsTest ()

Public Attributes

DialogTracker * mpDialogTracker

NatTraversalRules mRules

Private Member Functions

CPPUNIT_TEST_SUITE (DialogTrackerTest)

CPPUNIT_TEST (timerTickCounterTest)

CPPUNIT_TEST (DialogEstablishedFlagManipsTest)

CPPUNIT_TEST (TransactionDirectionalityFlagManipsTest)

CPPUNIT_TEST (MediaRelayRequiredFlagManipsTest)

CPPUNIT_TEST (MediaDescriptorsManipsTest)

CPPUNIT_TEST (getOurMediaRelayHandleEncodedInSdpTest)

CPPUNIT_TEST (requestHandledMarkerManipTest)

CPPUNIT_TEST (RequestRetransmissionDescriptorTest)

CPPUNIT_TEST (ResponseRetransmissionDescriptorTest)

CPPUNIT_TEST (RemoveUnwantedElementsTest)

CPPUNIT_TEST_SUITE_END ()

Constructor & Destructor Documentation

DialogTrackerTest ( ) [inline]

Member Function Documentation

CPPUNIT_TEST_SUITE ( DialogTrackerTest ) [private]

CPPUNIT_TEST ( timerTickCounterTest ) [private]

CPPUNIT_TEST ( DialogEstablishedFlagManipsTest ) [private]

CPPUNIT_TEST ( TransactionDirectionalityFlagManipsTest ) [private]

CPPUNIT_TEST ( MediaRelayRequiredFlagManipsTest ) [private]

CPPUNIT_TEST ( MediaDescriptorsManipsTest ) [private]

CPPUNIT_TEST ( getOurMediaRelayHandleEncodedInSdpTest ) [private]

CPPUNIT_TEST ( requestHandledMarkerManipTest ) [private]

CPPUNIT_TEST ( RequestRetransmissionDescriptorTest ) [private]

CPPUNIT_TEST ( ResponseRetransmissionDescriptorTest ) [private]

CPPUNIT_TEST ( RemoveUnwantedElementsTest ) [private]

CPPUNIT_TEST_SUITE_END ( ) [private]

bool doesEndpointsLocationImposeMediaRelay ( void ) const [inline, 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.

Implements SessionContextInterfaceForDialogTracker.

bool allocateMediaRelaySession	(	const UtlString &	handleOfRequestingDialogContext,
		tMediaRelayHandle &	relayHandle,
		int &	callerRelayRtpPort,
		int &	calleeRelayRtpPort
	)			`[inline, 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.

Implements SessionContextInterfaceForDialogTracker.

tMediaRelayHandle cloneMediaRelaySession	(	const UtlString &	handleOfRequestingDialogContext,
		tMediaRelayHandle &	relayHandleToClone,
		bool	doSwapCallerAndCallee
	)			`[inline, 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

Implements SessionContextInterfaceForDialogTracker.

bool deallocateMediaRelaySession	(	const UtlString &	handleOfRequestingDialogContext,
		const tMediaRelayHandle &	relayHandle
	)			`[inline, 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.

Implements SessionContextInterfaceForDialogTracker.

bool setMediaRelayDirectionMode	(	const UtlString &	handleOfRequestingDialogContext,
		const tMediaRelayHandle &	relayHandle,
		MediaDirectionality	mediaRelayDirectionMode,
		EndpointRole	endpointRole
	)			`[inline, 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.

Implements SessionContextInterfaceForDialogTracker.

bool linkFarEndMediaRelayPortToRequester	(	const UtlString &	handleOfRequestingDialogContext,
		const tMediaRelayHandle &	relayHandle,
		const MediaDescriptor *	pMediaDescriptor,
		EndpointRole	endpointRoleOfRequester
	)			`[inline, 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.

Implements SessionContextInterfaceForDialogTracker.

bool getMediaRelayAddressToUseInSdp	(	UtlString &	mediaRelayAddressToUse,
		EndpointRole	endpointRole
	)			const `[inline, 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

Implements SessionContextInterfaceForDialogTracker.

void reportDialogTrackerReadyForDeletion ( const UtlString & handleOfRequestingDialogContext ) [inline, 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

Implements SessionContextInterfaceForDialogTracker.

int getRtpRelayPortForMediaRelaySession	(	const tMediaRelayHandle &	handle,
		EndpointRole	endpointRole
	)			`[inline, 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

Implements SessionContextInterfaceForDialogTracker.

bool getPacketProcessingStatsForMediaRelaySession	(	const tMediaRelayHandle &	handle,
		PacketProcessingStatistics &	stats
	)			`[inline, 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

Implements SessionContextInterfaceForDialogTracker.

void setUp ( ) [inline]

void tearDown ( ) [inline]

void timerTickCounterTest ( ) [inline]

void DialogEstablishedFlagManipsTest ( ) [inline]

void TransactionDirectionalityFlagManipsTest ( ) [inline]

void MediaRelayRequiredFlagManipsTest ( ) [inline]

void MediaDescriptorsManipsTest ( ) [inline]

void getOurMediaRelayHandleEncodedInSdpTest ( ) [inline]

void requestHandledMarkerManipTest ( ) [inline]

void RequestRetransmissionDescriptorTest ( ) [inline]

void ResponseRetransmissionDescriptorTest ( ) [inline]

void RemoveUnwantedElementsTest ( ) [inline]

Member Data Documentation

DialogTracker* mpDialogTracker

NatTraversalRules mRules

DialogTrackerTest Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Online Library Docs

sipXecs home page


Public Member Functions
	DialogTrackerTest ()
bool	doesEndpointsLocationImposeMediaRelay (void) const
	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.
bool	allocateMediaRelaySession (const UtlString &handleOfRequestingDialogContext, tMediaRelayHandle &relayHandle, int &callerRelayRtpPort, int &calleeRelayRtpPort)
	Requests the allocation of a media relay session on the Smmitron.
tMediaRelayHandle	cloneMediaRelaySession (const UtlString &handleOfRequestingDialogContext, tMediaRelayHandle &relayHandleToClone, bool doSwapCallerAndCallee)
	Requests the cloning of an existing media relay session.
bool	deallocateMediaRelaySession (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle)
	Requests the de-allocation of a previously allocated media relay session.
bool	setMediaRelayDirectionMode (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle, MediaDirectionality mediaRelayDirectionMode, EndpointRole endpointRole)
	Configures the directionality of the media relay.
bool	linkFarEndMediaRelayPortToRequester (const UtlString &handleOfRequestingDialogContext, const tMediaRelayHandle &relayHandle, const MediaDescriptor *pMediaDescriptor, EndpointRole endpointRoleOfRequester)
	Establishes the requester as the media destination for the far-end's media relay port.
bool	getMediaRelayAddressToUseInSdp (UtlString &mediaRelayAddressToUse, EndpointRole endpointRole) const
	Computes the media relay IP address to use when patching SDP originating from endpoint designated by endpointRole param.
void	reportDialogTrackerReadyForDeletion (const UtlString &handleOfRequestingDialogContext)
	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.
int	getRtpRelayPortForMediaRelaySession (const tMediaRelayHandle &handle, EndpointRole role)
	Used to query the RTP port that a given MediaRelaySession has allocated to the endpoint whose role is passed as a parameter.
bool	getPacketProcessingStatsForMediaRelaySession (const tMediaRelayHandle &handle, PacketProcessingStatistics &stats)
	Retrieves the packet processing statistics for a given media relay session designated by its handle.
void	setUp ()
void	tearDown ()
void	timerTickCounterTest ()
void	DialogEstablishedFlagManipsTest ()
void	TransactionDirectionalityFlagManipsTest ()
void	MediaRelayRequiredFlagManipsTest ()
void	MediaDescriptorsManipsTest ()
void	getOurMediaRelayHandleEncodedInSdpTest ()
void	requestHandledMarkerManipTest ()
void	RequestRetransmissionDescriptorTest ()
void	ResponseRetransmissionDescriptorTest ()
void	RemoveUnwantedElementsTest ()
Public Attributes
DialogTracker *	mpDialogTracker
NatTraversalRules	mRules
Private Member Functions
	CPPUNIT_TEST_SUITE (DialogTrackerTest)
	CPPUNIT_TEST (timerTickCounterTest)
	CPPUNIT_TEST (DialogEstablishedFlagManipsTest)
	CPPUNIT_TEST (TransactionDirectionalityFlagManipsTest)
	CPPUNIT_TEST (MediaRelayRequiredFlagManipsTest)
	CPPUNIT_TEST (MediaDescriptorsManipsTest)
	CPPUNIT_TEST (getOurMediaRelayHandleEncodedInSdpTest)
	CPPUNIT_TEST (requestHandledMarkerManipTest)
	CPPUNIT_TEST (RequestRetransmissionDescriptorTest)
	CPPUNIT_TEST (ResponseRetransmissionDescriptorTest)
	CPPUNIT_TEST (RemoveUnwantedElementsTest)
	CPPUNIT_TEST_SUITE_END ()