OpalDummySession Class Reference

#include <mediasession.h>

Inheritance diagram for OpalDummySession:

Collaboration diagram for OpalDummySession:

Public Member Functions
	OpalDummySession (const Init &init)
	OpalDummySession (const Init &init, const OpalTransportAddressArray &transports)
virtual const PCaselessString &	GetSessionType () const
virtual bool	Open (const PString &localInterface, const OpalTransportAddress &remoteAddress)
virtual bool	IsOpen () const
virtual OpalTransportAddress	GetLocalAddress (bool isMediaAddress=true) const
virtual OpalTransportAddress	GetRemoteAddress (bool isMediaAddress=true) const
virtual bool	SetRemoteAddress (const OpalTransportAddress &remoteAddress, bool isMediaAddress=true)
virtual void	AttachTransport (const OpalMediaTransportPtr &)
virtual OpalMediaTransportPtr	DetachTransport ()
virtual OpalMediaStream *	CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)
Public Member Functions inherited from OpalMediaSession
	~OpalMediaSession ()
virtual void	PrintOn (ostream &strm) const
virtual void	Start ()
virtual bool	IsEstablished () const
virtual bool	Close ()
OpalMediaTransportPtr	GetTransport () const
virtual bool	UpdateMediaFormat (const OpalMediaFormat &mediaFormat)
virtual bool	AddGroup (const PString &groupId, const PString &mediaId, bool overwrite=true)
bool	IsGroupMember (const PString &groupId) const
PStringArray	GetGroups () const
PString	GetGroupMediaId (const PString &groupId) const
virtual void	GetStatistics (OpalMediaStatistics &statistics, bool receiver) const
void	SetRemoteBehindNAT ()
	Indicate remote is behind NAT. More...
bool	IsRemoteBehindNAT () const
void	OfferCryptoSuite (const PString &cryptoSuite)
virtual OpalMediaCryptoKeyList &	GetOfferedCryptoKeys ()
virtual bool	ApplyCryptoKey (OpalMediaCryptoKeyList &keys, bool rx)
virtual OpalMediaCryptoKeyInfo *	IsCryptoSecured (bool rx) const
OpalConnection &	GetConnection () const
unsigned	GetSessionID () const
const OpalMediaType &	GetMediaType () const
const PStringOptions &	GetStringOptions () const
void	SetStringOptions (const PStringOptions &options)

Static Public Member Functions
static const PCaselessString &	SessionType ()
Static Public Member Functions inherited from OpalMediaSession
static const PString &	GetBundleGroupId ()

Additional Inherited Members
Public Types inherited from OpalMediaTransportChannelTypes
enum	SubChannels {   e_AllSubChannels = -1, e_Media, e_Data = e_Media, e_Control,   eSubChannelA, eSubChannelB, eSubChannelC, eSubChannelD,   eMaxSubChannels }
Protected Member Functions inherited from OpalMediaSession
	OpalMediaSession (const Init &init)
Protected Attributes inherited from OpalMediaSession
OpalConnection &	m_connection
unsigned	m_sessionId
OpalMediaType	m_mediaType
bool	m_remoteBehindNAT
PStringOptions	m_stringOptions
PStringToString	m_groups
OpalMediaTransportPtr	m_transport
OpalMediaCryptoKeyList	m_offeredCryptokeys

Detailed Description

Dummy session. This is a place holder for the local and remote address in use for a session, but there is no actual implementation that does anything. It is used for cases such as unknown media types in SDP or external "bypassed" media sessions where data is sent driectly between two remote endpoints and not throught the local machine at all.

Constructor & Destructor Documentation

OpalDummySession::OpalDummySession

(

const Init &

init

)

OpalDummySession::OpalDummySession	(	const Init &	init,
		const OpalTransportAddressArray &	transports
	)

Member Function Documentation

virtual void OpalDummySession::AttachTransport ( const OpalMediaTransportPtr &  transport )

virtual

Attach an existing set of transport channels to media session.

Reimplemented from OpalMediaSession.

virtual OpalMediaStream* OpalDummySession::CreateMediaStream ( const OpalMediaFormat &  mediaFormat, unsigned  sessionID, bool  isSource  )

virtual

Create an appropriate media stread for this media session.

Implements OpalMediaSession.

virtual OpalMediaTransportPtr OpalDummySession::DetachTransport ( )

virtual

Detach the transport channels from the media session. Note that while the channels are not closed, the media session will be. Also note that the channel objects are now owned by the Transport PList so care must be take when removing them in such a way they are not deleted unexpectedly.

Reimplemented from OpalMediaSession.

virtual OpalTransportAddress OpalDummySession::GetLocalAddress ( bool  isMediaAddress = true ) const

virtual

Get the local transport address used by this media session. The isMediaAddress can get an optional secondary channel address when false.

Reimplemented from OpalMediaSession.

virtual OpalTransportAddress OpalDummySession::GetRemoteAddress ( bool  isMediaAddress = true ) const

virtual

Get the remote transport address used by this media session. The isMediaAddress can get an optional secondary channel address when false.

Reimplemented from OpalMediaSession.

virtual const PCaselessString& OpalDummySession::GetSessionType ( ) const

virtual

Get the session type string (for factory).

Implements OpalMediaSession.

virtual bool OpalDummySession::IsOpen ( ) const

virtual

Indicate if media session is open.

Reimplemented from OpalMediaSession.

virtual bool OpalDummySession::Open ( const PString &  localInterface, const OpalTransportAddress &  remoteAddress  )

virtual

Open the media session.

Implements OpalMediaSession.

static const PCaselessString& OpalDummySession::SessionType ( )

static

virtual bool OpalDummySession::SetRemoteAddress ( const OpalTransportAddress &  remoteAddress, bool  isMediaAddress = true  )

virtual

Set the remote transport address used by this media session. The isMediaAddress can get an optional secondary channel address when false.

Reimplemented from OpalMediaSession.

---

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

• mediasession.h