#include <rtpconn.h>

Inheritance diagram for OpalRTPConnection:

Collaboration diagram for OpalRTPConnection:

Data Structures
class	SessionMap

Public Member Functions
Construction
	OpalRTPConnection (OpalCall &call, OpalRTPEndPoint &endpoint, const PString &token, unsigned options=0, OpalConnection::StringOptions *stringOptions=NULL)

	~OpalRTPConnection ()

virtual void	OnReleased ()

Overrides from OpalConnection
virtual OpalMediaStream *	CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource)

virtual bool	GetMediaTransportAddresses (OpalConnection &otherConnection, const OpalMediaType &mediaType, OpalTransportAddressArray &transports) const

virtual void	AdjustMediaFormats (bool local, const OpalConnection *otherConnection, OpalMediaFormatList &mediaFormats) const

virtual void	OnPatchMediaStream (PBoolean isSource, OpalMediaPatch &patch)

virtual bool	OnMediaCommand (OpalMediaStream &stream, const OpalMediaCommand &command)

virtual PBoolean	SendUserInputTone (char tone, unsigned duration=0)

RTP Session Management
virtual unsigned	GetNextSessionID (const OpalMediaType &mediaType, bool isSource)

	P_DECLARE_BITWISE_ENUM (CreateMediaSessionsSecurity, 2,(e_NoMediaSessions, e_ClearMediaSession, e_SecureMediaSession))

vector< bool >	CreateAllMediaSessions (CreateMediaSessionsSecurity security)

virtual OpalMediaSession *	CreateMediaSession (unsigned sessionId, const OpalMediaType &mediaType, const PString &sessionType=PString::Empty())

virtual OpalMediaSession *	GetMediaSession (unsigned sessionID) const

virtual OpalMediaSession *	FindSessionByMediaType (const OpalMediaType &mediaType) const

virtual OpalMediaSession *	FindSessionByLocalPort (WORD port) const

virtual OpalMediaSession *	UseMediaSession (unsigned sessionId, const OpalMediaType &mediaType, const PString &sessionType=PString::Empty())

virtual void	ReleaseMediaSession (unsigned sessionID)

virtual bool	ChangeSessionID (unsigned fromSessionID, unsigned toSessionID)

virtual void	ReplaceMediaSession (unsigned sessionId, OpalMediaSession *mediaSession)

virtual bool	SetSessionQoS (OpalRTPSession *session)

NAT Management
virtual void	DetermineRTPNAT (const OpalTransport &transport, const OpalTransportAddress &signalAddr)

Public Member Functions inherited from OpalConnection
	P_DECLARE_TRACED_ENUM_EX (CallEndReasonCodes, NumCallEndReasons, EndedByLocalUser, 0, EndedByNoAccept, EndedByAnswerDenied, EndedByRemoteUser, EndedByRefusal, EndedByNoAnswer, EndedByCallerAbort, EndedByTransportFail, EndedByConnectFail, EndedByGatekeeper, EndedByNoUser, EndedByNoBandwidth, EndedByCapabilityExchange, EndedByCallForwarded, EndedBySecurityDenial, EndedByLocalBusy, EndedByLocalCongestion, EndedByRemoteBusy, EndedByRemoteCongestion, EndedByUnreachable, EndedByNoEndPoint, EndedByHostOffline, EndedByTemporaryFailure, EndedByQ931Cause, EndedByDurationLimit, EndedByInvalidConferenceID, EndedByNoDialTone, EndedByNoRingBackTone, EndedByOutOfService, EndedByAcceptingCallWaiting, EndedByGkAdmissionFailed, EndedByMediaFailed, EndedByCallCompletedElsewhere, EndedByCertificateAuthority, EndedByIllegalAddress, EndedByCustomCode)

	P_DECLARE_TRACED_ENUM (AnswerCallResponse, AnswerCallNow, AnswerCallDenied, AnswerCallPending, AnswerCallDeferred, AnswerCallAlertWithMedia, AnswerCallDeferredWithMedia, AnswerCallProgress, AnswerCallNowAndReleaseCurrent)

const StringOptions &	GetStringOptions () const
	Get the string options associated with this connection. More...

StringOptions &	GetStringOptions ()

void	SetStringOptions (const StringOptions &options, bool overwrite)
	Set the string options associated with this connection. More...

virtual void	OnApplyStringOptions ()
	Call back for connection to act on changed string options. More...

virtual void	EnableRecording ()

virtual void	DisableRecording ()

	OpalConnection (OpalCall &call, OpalEndPoint &endpoint, const PString &token, unsigned options=0, OpalConnection::StringOptions *stringOptions=NULL)

	~OpalConnection ()

void	PrintOn (ostream &strm) const

virtual PBoolean	OnIncomingConnection (unsigned int options, OpalConnection::StringOptions *stringOptions)

virtual PBoolean	SetUpConnection ()

virtual PBoolean	OnSetUpConnection ()

virtual void	OnProceeding ()

virtual void	OnAlerting ()

virtual PBoolean	SetAlerting (const PString &calleeName, PBoolean withMedia)

virtual AnswerCallResponse	OnAnswerCall (const PString &callerName)

virtual void	AnsweringCall (AnswerCallResponse response)

virtual void	OnConnected ()

virtual PBoolean	SetConnected ()

virtual void	OnEstablished ()

virtual bool	OnTransferNotify (const PStringToString &info, const OpalConnection *transferringConnection)

virtual void	Release (CallEndReason reason=EndedByLocalUser, bool synchronous=false)

virtual PString	GetDestinationAddress ()

virtual PBoolean	ForwardCall (const PString &forwardParty)

PSafePtr< OpalConnection >	GetOtherPartyConnection () const

template<class cls >
PSafePtr< cls >	GetOtherPartyConnectionAs () const

virtual OpalMediaFormatList	GetMediaFormats () const

virtual OpalMediaFormatList	GetLocalMediaFormats ()

virtual PStringArray	GetMediaCryptoSuites () const

virtual bool	RequireSymmetricMediaStreams () const

virtual OpalMediaType::AutoStartMode	GetAutoStart (const OpalMediaType &mediaType) const

virtual void	AutoStartMediaStreams (bool transfer=false)

virtual OpalMediaStreamPtr	OpenMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

bool	CloseMediaStream (unsigned sessionId, bool source)

bool	CloseMediaStream (OpalMediaStreamPtr stream)

bool	RemoveMediaStream (OpalMediaStream &strm)

virtual void	StartMediaStreams ()

virtual void	CloseMediaStreams ()

virtual void	PauseMediaStreams (bool paused)

virtual void	OnPauseMediaStream (OpalMediaStream &strm, bool paused)

OpalMediaStreamPtr	GetMediaStream (const PString &streamID, bool source) const

OpalMediaStreamPtr	GetMediaStream (unsigned sessionId, bool source) const

OpalMediaStreamPtr	GetMediaStream (const OpalMediaType &mediaType, bool source, OpalMediaStreamPtr previous=NULL) const

virtual PBoolean	OnOpenMediaStream (OpalMediaStream &stream)

virtual void	OnClosedMediaStream (const OpalMediaStream &stream)

virtual void	OnFailedMediaStream (bool fromRemote, const PString &reason)

virtual void	OnStartMediaPatch (OpalMediaPatch &patch)

virtual void	OnStopMediaPatch (OpalMediaPatch &patch)

virtual bool	OnMediaFailed (unsigned sessionId, bool source)

bool	AllMediaFailed () const

virtual bool	ExecuteMediaCommand (const OpalMediaCommand &command, unsigned sessionID=0, const OpalMediaType &mediaType=OpalMediaType()) const

virtual bool	SendVideoUpdatePicture (unsigned sessionID=0, bool force=false) const

void	SendVideoUpdatePictureCallback (unsigned sessionID, bool force)

virtual void	OnRxIntraFrameRequest (const OpalMediaSession &session, bool force)

virtual PBoolean	SetAudioVolume (PBoolean source, unsigned percentage)

virtual PBoolean	GetAudioVolume (PBoolean source, unsigned &percentage)

virtual bool	SetAudioMute (bool source, bool mute)

virtual bool	GetAudioMute (bool source, bool &mute)

virtual unsigned	GetAudioSignalLevel (PBoolean source)

OpalBandwidth	GetBandwidthAvailable (OpalBandwidth::Direction dir) const

virtual bool	SetBandwidthAvailable (OpalBandwidth::Direction dir, OpalBandwidth availableBandwidth)

virtual bool	SetBandwidthAllocated (OpalBandwidth::Direction dir, OpalBandwidth newBandwidth)

virtual OpalBandwidth	GetBandwidthUsed (OpalBandwidth::Direction dir) const

virtual bool	SetBandwidthUsed (OpalBandwidth::Direction dir, OpalBandwidth releasedBandwidth, OpalBandwidth requiredBandwidth)

	P_DECLARE_TRACED_ENUM (SendUserInputModes, SendUserInputAsQ931, SendUserInputAsString, SendUserInputAsTone, SendUserInputAsRFC2833, SendUserInputAsInlineRFC2833=SendUserInputAsRFC2833, SendUserInputInBand, SendUserInputAsProtocolDefault)

virtual void	SetSendUserInputMode (SendUserInputModes mode)

virtual SendUserInputModes	GetSendUserInputMode () const

virtual SendUserInputModes	GetRealSendUserInputMode () const

virtual PBoolean	SendUserInputString (const PString &value)

virtual void	OnUserInputString (const PString &value)

void	OnUserInputStringCallback (PString value)

virtual void	OnUserInputTone (char tone, unsigned duration)

void	SendUserInputHookFlash (unsigned duration=500)

virtual PString	GetUserInput (unsigned timeout=30)

virtual void	SetUserInput (const PString &input)

virtual PString	ReadUserInput (const char *terminators="YX#\r\n", unsigned lastDigitTimeout=4, unsigned firstDigitTimeout=30)

virtual PBoolean	PromptUserInput (PBoolean play)

virtual bool	GetConferenceState (OpalConferenceState *state) const

virtual bool	RequestPresentationRole (bool release)

virtual bool	OnChangedPresentationRole (const PString &newChairURI, bool request)

virtual bool	HasPresentationRole () const

OpalEndPoint &	GetEndPoint () const

OpalCall &	GetCall () const

const PString &	GetToken () const

PBoolean	IsOriginating () const

const PTime &	GetPhaseTime (Phases phase) const

const PTime &	GetSetupUpTime () const

const PTime &	GetAlertingTime () const

const PTime &	GetConnectionStartTime () const

const PTime &	GetConnectionEndTime () const

const OpalProductInfo &	GetProductInfo () const

void	SetProductInfo (const OpalProductInfo &info)

virtual PString	GetPrefixName () const

const PString &	GetLocalPartyName () const

virtual void	SetLocalPartyName (const PString &name)

virtual PString	GetLocalPartyURL () const

const PString &	GetDisplayName () const

void	SetDisplayName (const PString &name)

virtual bool	IsPresentationBlocked () const

const PString &	GetRemotePartyName () const

void	SetRemotePartyName (const PString &name)

const PString &	GetRemotePartyNumber () const

virtual OpalTransportAddress	GetRemoteAddress () const

virtual PString	GetRemotePartyURL () const

virtual PString	GetRemoteIdentity () const

P_DEPRECATED PString	GetRemotePartyAddress () const

P_DEPRECATED const PString	GetRemotePartyCallbackURL () const

PCaselessString	GetRemoteApplication () const

const OpalProductInfo &	GetRemoteProductInfo () const

const PString &	GetRedirectingParty () const

void	SetRedirectingParty (const PString &party)

const PString &	GetCalledPartyName () const

const PString &	GetCalledPartyNumber () const

virtual PString	GetCalledPartyURL ()

void	CopyPartyNames (const OpalConnection &other)

virtual PString	GetAlertingType () const

virtual bool	SetAlertingType (const PString &info)

virtual PString	GetCallInfo () const

unsigned	GetMinAudioJitterDelay () const

unsigned	GetMaxAudioJitterDelay () const

void	SetAudioJitterDelay (unsigned minDelay, unsigned maxDelay)

OpalSilenceDetector *	GetSilenceDetector () const

virtual PString	GetIdentifier () const

virtual PINDEX	GetMaxRtpPayloadSize () const

unsigned	GetVideoUpdateRequestsSent () const

unsigned	GetVideoUpdateRequestsReceived () const

virtual bool	IsNetworkConnection () const =0

	P_DECLARE_TRACED_ENUM (Phases, UninitialisedPhase, SetUpPhase, ProceedingPhase, AlertingPhase, ConnectedPhase, EstablishedPhase, ForwardingPhase, ReleasingPhase, ReleasedPhase)

__inline Phases	GetPhase () const

__inline bool	IsEstablished () const
	Return true if connection is in the established phase. More...

__inline bool	IsReleased () const
	Return true if connection is in the established phase. More...

void	SetPhase (Phases phaseToSet)

CallEndReason	GetCallEndReason () const

PString	GetCallEndReasonText () const

virtual void	SetCallEndReason (CallEndReason reason)

void	ClearCall (CallEndReason reason=EndedByLocalUser, PSyncPoint *sync=NULL)

virtual void	ClearCallSynchronous (PSyncPoint *sync, CallEndReason reason=EndedByLocalUser)

unsigned	GetQ931Cause () const

void	SetQ931Cause (unsigned v)

virtual bool	TransferConnection (const PString &remoteParty)

virtual bool	HoldRemote (bool placeOnHold)

virtual bool	IsOnHold (bool fromRemote) const

virtual void	OnHold (bool fromRemote, bool onHold)

Protected Member Functions
virtual bool	GarbageCollection ()

	PDECLARE_NOTIFIER (OpalRFC2833Info, OpalRTPConnection, OnUserInputInlineRFC2833)

virtual bool	NoMediaBypass (const OpalConnection &otherConnection, const OpalMediaType &mediaType) const

	P_REMOVE_VIRTUAL (PBoolean, IsRTPNATEnabled(const PIPSocket::Address &, const PIPSocket::Address &, const PIPSocket::Address &, PBoolean), false)

Protected Member Functions inherited from OpalConnection
void	OnConnectedInternal ()

void	InternalSetAsOriginating ()

bool	InternalRelease (CallEndReason reason)

void	InternalOnReleased ()

	PDECLARE_NOTIFIER (RTP_DataFrame, OpalConnection, OnRecordAudio)

	PDECLARE_NOTIFIER (RTP_DataFrame, OpalConnection, OnRecordVideo)

void	OnStartRecording (OpalMediaPatch *patch)

void	OnStopRecording (OpalMediaPatch *patch)

Protected Attributes
SessionMap	m_sessions

bool	m_remoteBehindNAT

OpalRFC2833Proto *	m_rfc2833Handler

Protected Attributes inherited from OpalConnection
OpalCall &	ownerCall

OpalEndPoint &	endpoint

PString	callToken

PBoolean	m_originating

OpalProductInfo	productInfo

PString	localPartyName

PString	displayName

PString	remotePartyName

PString	m_remotePartyURL

OpalProductInfo	remoteProductInfo

PString	remotePartyNumber

PString	m_redirectingParty

CallEndReason	callEndReason

PString	m_calledPartyNumber

PString	m_calledPartyName

SendUserInputModes	sendUserInputMode

PString	userInputString

PSyncPoint	userInputAvailable

OpalSilenceDetector *	silenceDetector

OpalMediaFormat	m_filterMediaFormat

OpalMediaFormatList	m_localMediaFormats

PSafeList< OpalMediaStream >	mediaStreams

unsigned	m_minAudioJitterDelay

unsigned	m_maxAudioJitterDelay

OpalBandwidth	m_rxBandwidthAvailable

OpalBandwidth	m_txBandwidthAvailable

StringOptions	m_stringOptions

PString	m_recordingFilename

PNotifier	m_recordAudioNotifier

PNotifier	m_recordVideoNotifier

unsigned	m_VideoUpdateRequestsSent

unsigned	m_VideoUpdateRequestsReceived

OpalMediaType::AutoStartMap	m_autoStartInfo

ZeroTime	m_phaseTime [NumPhases]

std::set< unsigned >	m_mediaSessionFailed

Additional Inherited Members
Public Types inherited from OpalConnection
enum	Options { FastStartOptionDisable = 0x0001, FastStartOptionEnable = 0x0002, FastStartOptionMask = 0x0003, H245TunnelingOptionDisable = 0x0004, H245TunnelingOptionEnable = 0x0008, H245TunnelingOptionMask = 0x000c, H245inSetupOptionDisable = 0x0010, H245inSetupOptionEnable = 0x0020, H245inSetupOptionMask = 0x0030, DetectInBandDTMFOptionDisable = 0x0040, DetectInBandDTMFOptionEnable = 0x0080, DetectInBandDTMFOptionMask = 0x00c0, RTPAggregationDisable = 0x0100, RTPAggregationEnable = 0x0200, RTPAggregationMask = 0x0300, SendDTMFAsDefault = 0x0000, SendDTMFAsString = 0x0400, SendDTMFAsTone = 0x0800, SendDTMFAsRFC2833 = 0x0c00, SendDTMFMask = 0x0c00 }

Static Public Member Functions inherited from OpalConnection
static PString	GetCallEndReasonText (CallEndReason reason)

static void	SetCallEndReasonText (CallEndReasonCodes reasonCode, const PString &newText)

Detailed Description

This is the base class for OpalConnections that use RTP sessions, such as H.323 and SIPconnections to an endpoint.

Constructor & Destructor Documentation

OpalRTPConnection::OpalRTPConnection	(	OpalCall &	call,
		OpalRTPEndPoint &	endpoint,
		const PString &	token,
		unsigned	options = `0`,
		OpalConnection::StringOptions *	stringOptions = `NULL`
	)

Create a new connection.

Parameters

call	Owner calll for connection
endpoint	Owner endpoint for connection
token	Token to identify the connection
options	Connection options
stringOptions	more complex options

OpalRTPConnection::~OpalRTPConnection ( )

Destroy connection.

Member Function Documentation

virtual void OpalRTPConnection::AdjustMediaFormats	(	bool	local,
		const OpalConnection *	otherConnection,
		OpalMediaFormatList &	mediaFormats
	)		const

virtual

Adjust media formats available on a connection. This is called by a connection after it has called OpalCall::GetMediaFormats() to get all media formats that it can use so that an application may remove or reorder the media formats before they are used to open media streams.

This function may also be executed by other connections in the call. If this happens then the "otherConnection" parameter will be non-NULL. The "local" parameter sense is relative to the "otherConnection" parameter, if NULL then it is relative to "this".

The default behaviour calls the OpalEndPoint function of the same name.

Parameters

local	Media formats a local ones to be presented to remote
otherConnection	Other connection we are adjusting media for
mediaFormats	Media formats to use

Reimplemented from OpalConnection.

virtual bool OpalRTPConnection::ChangeSessionID	(	unsigned	fromSessionID,
		unsigned	toSessionID
	)

virtual

Change the sessionID for an existing session. This will adjust the RTP session and media streams.

Return false if no such session exists.

Parameters

fromSessionID	Session ID to search for
toSessionID	Session ID to change to

vector<bool> OpalRTPConnection::CreateAllMediaSessions ( CreateMediaSessionsSecurity security )

Create all media sessions for available media types. Note that the sessions are not opened, just created.

Sessions using media security will alsoe be created if secure is true. This indicates the media key exchange can be done securely, typically it means signaling channel is also secure.

Returns: a list of the media types for which sessions where created.

Parameters

security Wse secure media, or not

virtual OpalMediaSession* OpalRTPConnection::CreateMediaSession	(	unsigned	sessionId,
		const OpalMediaType &	mediaType,
		const PString &	sessionType = `PString::Empty()`
	)

virtual

Create an RTP session for the specified ID. The type of RTP session that is created will be compatible with the transport. At this time only IP (RTP over UDP) is supported.

Parameters

sessionId	Unique (in connection) session ID for session
mediaType	Media type for session
sessionType	Type of session to create

virtual OpalMediaStream* OpalRTPConnection::CreateMediaStream	(	const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		PBoolean	isSource
	)

virtual

Create a new media stream. This will create a media stream of an appropriate subclass as required by the underlying connection protocol. For instance H.323 would create an OpalRTPStream.

The sessionID parameter may not be needed by a particular media stream and may be ignored. In the case of an OpalRTPStream it us used.

Note that media streams may be created internally to the underlying protocol. This function is not the only way a stream can come into existance.

Parameters

mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream

Reimplemented from OpalConnection.

Reimplemented in SIPConnection.

virtual void OpalRTPConnection::DetermineRTPNAT	(	const OpalTransport &	transport,
		const OpalTransportAddress &	signalAddr
	)

virtual

Determine if the RTP session needs to accommodate a NAT router. For endpoints that do not use STUN or something similar to set up all the correct protocol embeddded addresses correctly when a NAT router is between the endpoints, it is possible to still accommodate the call, with some restrictions. This function determines if the RTP can proceed with special NAT allowances.

The special allowance is that the RTP code will ignore whatever the remote indicates in the protocol for the address to send RTP data and wait for the first packet to arrive from the remote and will then proceed to send all RTP data back to that address AND port.

The default behaviour checks the values of the physical link (localAddr/peerAddr) against the signaling address the remote indicated in the protocol, eg H.323 SETUP sourceCallSignalAddress or SIP "To" or "Contact" fields, and makes a guess that the remote is behind a NAT router.

Parameters

transport	Transport to get physical address of connection
signalAddr	Remotes signaling address as indicated by protocol of connection

Reimplemented in H323Connection.

virtual OpalMediaSession* OpalRTPConnection::FindSessionByLocalPort ( WORD port ) const

virtual

Find an RTP session for the specified local port. If there is no session, NULL is returned.

Parameters

port	Local port number

virtual OpalMediaSession* OpalRTPConnection::FindSessionByMediaType ( const OpalMediaType & mediaType ) const

virtual

Find an RTP session for the media type. If there is no session, NULL is returned.

Parameters

mediaType Media type for session

virtual bool OpalRTPConnection::GarbageCollection ( )

protectedvirtual

Execute garbage collection for endpoint. Returns true if all garbage has been collected. Default behaviour deletes the objects in the connectionsActive list.

Reimplemented from OpalConnection.

Reimplemented in SIPConnection.

virtual OpalMediaSession* OpalRTPConnection::GetMediaSession ( unsigned sessionID ) const

virtual

Get an RTP session for the specified ID. If there is no session of the specified ID, NULL is returned.

Parameters

sessionID RTP session number

virtual bool OpalRTPConnection::GetMediaTransportAddresses	(	OpalConnection &	otherConnection,
		const OpalMediaType &	mediaType,
		OpalTransportAddressArray &	transports
	)		const

virtual

Get transports for the media session on the connection. This is primarily used by the media bypass feature controlled by the OpalManager::GetMediaTransferMode() function. It allows one side of the call to get the transport address of the media on the other side, so it can pass it on, bypassing the local host.

Returns: true if a transport address is available and may be used to pass on to a remote system for direct access.

Parameters

otherConnection	Other half of call needing media transport addresses
mediaType	Media type for session to return information
transports	Information on media session

Reimplemented from OpalConnection.

Reimplemented in SIPConnection, and H323Connection.

virtual unsigned OpalRTPConnection::GetNextSessionID	(	const OpalMediaType &	mediaType,
		bool	isSource
	)

virtual

Get next available session ID for the media type.

Parameters

mediaType	Media type of stream being opened
isSource	Stream is a source/sink

Reimplemented from OpalConnection.

Reimplemented in H323Connection.

virtual bool OpalRTPConnection::NoMediaBypass	(	const OpalConnection &	otherConnection,
		const OpalMediaType &	mediaType
	)		const

protectedvirtual

virtual bool OpalRTPConnection::OnMediaCommand	(	OpalMediaStream &	stream,
		const OpalMediaCommand &	command
	)

virtual

Callback for media commands. Calls the SendIntraFrameRequest on the rtp session

Returns: true if command is handled.

Parameters

stream	Stream command executed on
command	Media command being executed

Reimplemented from OpalConnection.

Reimplemented in H323Connection, and SIPConnection.

virtual void OpalRTPConnection::OnPatchMediaStream	(	PBoolean	isSource,
		OpalMediaPatch &	patch
	)

virtual

Call back when patching a media stream. This function is called when a connection has created a new media patch between two streams. This is usually called twice per media patch, once for the source stream and once for the sink stream.

Note this is not called within the context of the patch thread and is called before that thread has started.

Parameters

isSource	Is source/sink call
patch	New patch

Reimplemented from OpalConnection.

Reimplemented in SIPConnection.

virtual void OpalRTPConnection::OnReleased ( )

virtual

Clean up the termination of the connection. This function can do any internal cleaning up and waiting on background threads that may be using the connection object.

Note that there is not a one to one relationship with the OnEstablishedConnection() function. This function may be called without that function being called. For example if SetUpConnection() was used but the call never completed.

Classes that override this function should make sure they call the ancestor version for correct operation.

An application will not typically call this function as it is used by the OpalManager during a release of the connection.

The default behaviour calls the OpalEndPoint function of the same name.

Reimplemented from OpalConnection.

Reimplemented in SIPConnection, and H323Connection.

OpalRTPConnection::P_DECLARE_BITWISE_ENUM	(	CreateMediaSessionsSecurity	,
		2	,
		(e_NoMediaSessions, e_ClearMediaSession, e_SecureMediaSession)
	)

OpalRTPConnection::P_REMOVE_VIRTUAL	(	PBoolean	,
		IsRTPNATEnabled(const PIPSocket::Address &, const PIPSocket::Address &, const PIPSocket::Address &, PBoolean)	,
		false
	)

protected

OpalRTPConnection::PDECLARE_NOTIFIER	(	OpalRFC2833Info	,
		OpalRTPConnection	,
		OnUserInputInlineRFC2833
	)

protected

virtual void OpalRTPConnection::ReleaseMediaSession ( unsigned sessionID )

virtual

Release the session.

Parameters

sessionID RTP session number

virtual void OpalRTPConnection::ReplaceMediaSession	(	unsigned	sessionId,
		OpalMediaSession *	mediaSession
	)

virtual

Replace existing session with new one, exchanging transports.

Parameters

sessionId	Session ID to replace
mediaSession	New session

virtual PBoolean OpalRTPConnection::SendUserInputTone	(	char	tone,
		unsigned	duration = `0`
	)

virtual

Send a user input indication to the remote endpoint. This sends DTMF emulation user input indication.

The tone parameter must be one of "0123456789#*ABCD!" where '!' indicates a hook flash. If tone is a ' ' character then a signalUpdate PDU is sent that updates the last tone indication sent. See the H.245 specifcation for more details on this.

A duration of zero indicates that a default duration (90ms) is to be used.

The default behaviour sends the tone using RFC2833.

Parameters

tone	DTMF tone code
duration	Duration of tone in milliseconds

Reimplemented from OpalConnection.

Reimplemented in H323Connection, and SIPConnection.

virtual bool OpalRTPConnection::SetSessionQoS ( OpalRTPSession * session )

virtual

Set QoS on session.

virtual OpalMediaSession* OpalRTPConnection::UseMediaSession	(	unsigned	sessionId,
		const OpalMediaType &	mediaType,
		const PString &	sessionType = `PString::Empty()`
	)

virtual

Use an RTP session for the specified ID. This will find a session of the specified ID and uses it if available.

If there is no session of the specified ID one is created.

The type of RTP session that is created will be compatible with the transport. At this time only IP (RTP over UDP) is supported.

Parameters

sessionId	Unique (in connection) session ID for session
mediaType	Media type for session
sessionType	Type of session to create

Field Documentation

bool OpalRTPConnection::m_remoteBehindNAT

protected

OpalRFC2833Proto* OpalRTPConnection::m_rfc2833Handler

protected

SessionMap OpalRTPConnection::m_sessions

protected

The documentation for this class was generated from the following file:

rtpconn.h

Data Structures

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation