OpalMSRPMediaSession Class Reference

#include <msrp.h>

Inheritance diagram for OpalMSRPMediaSession:

Collaboration diagram for OpalMSRPMediaSession:

Public Member Functions
	OpalMSRPMediaSession (const Init &init)
	~OpalMSRPMediaSession ()
virtual PObject *	Clone () const
virtual const PCaselessString &	GetSessionType () const
virtual bool	Open (const PString &localInterface, const OpalTransportAddress &remoteAddress)
virtual bool	Close ()
virtual OpalTransportAddress	GetLocalAddress (bool isMediaAddress=true) const
virtual OpalTransportAddress	GetRemoteAddress (bool isMediaAddress=true) const
virtual bool	SetRemoteAddress (const OpalTransportAddress &remoteAddress, bool isMediaAddress=true)
PURL	GetLocalURL () const
PURL	GetRemoteURL () const
void	SetRemoteURL (const PURL &url)
virtual bool	WritePacket (RTP_DataFrame &frame)
PBoolean	ReadData (BYTE *data, PINDEX length, PINDEX &read)
virtual OpalMediaStream *	CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource)
OpalMSRPManager &	GetManager ()
bool	OpenMSRP (const PURL &remoteUrl)
void	CloseMSRP ()
void	SetConnection (PSafePtr< OpalMSRPManager::Connection > &conn)
Public Member Functions inherited from OpalMediaSession
	~OpalMediaSession ()
virtual void	PrintOn (ostream &strm) const
virtual bool	IsOpen () const
virtual void	Start ()
virtual bool	IsEstablished () const
virtual void	AttachTransport (const OpalMediaTransportPtr &transport)
virtual OpalMediaTransportPtr	DetachTransport ()
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 OpalMediaStream *	CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)=0
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 &	TCP_MSRP ()
Static Public Member Functions inherited from OpalMediaSession
static const PString &	GetBundleGroupId ()

Data Fields
OpalMSRPManager &	m_manager
bool	m_isOriginating
std::string	m_localMSRPSessionId
PURL	m_localUrl
PURL	m_remoteUrl
PSafePtr < OpalMSRPManager::Connection >	m_connectionPtr
OpalTransportAddress	m_remoteAddress

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

Class for carrying MSRP session information

Constructor & Destructor Documentation

OpalMSRPMediaSession::OpalMSRPMediaSession

(

const Init &

init

)

Referenced by Clone().

OpalMSRPMediaSession::~OpalMSRPMediaSession

(

)

Member Function Documentation

virtual PObject* OpalMSRPMediaSession::Clone ( ) const

inlinevirtual

References OpalMSRPMediaSession().

virtual bool OpalMSRPMediaSession::Close ( )

virtual

Close the media session.

Reimplemented from OpalMediaSession.

void OpalMSRPMediaSession::CloseMSRP

(

)

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

virtual

virtual OpalTransportAddress OpalMSRPMediaSession::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.

PURL OpalMSRPMediaSession::GetLocalURL ( ) const

inline

References m_localUrl.

OpalMSRPManager& OpalMSRPMediaSession::GetManager ( )

inline

References m_manager.

virtual OpalTransportAddress OpalMSRPMediaSession::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.

PURL OpalMSRPMediaSession::GetRemoteURL ( ) const

inline

References m_remoteUrl.

Referenced by OpalMSRPMediaStream::GetRemoteURL().

virtual const PCaselessString& OpalMSRPMediaSession::GetSessionType ( ) const

inlinevirtual

Get the session type string (for factory).

Implements OpalMediaSession.

References TCP_MSRP().

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

virtual

Open the media session.

Implements OpalMediaSession.

bool OpalMSRPMediaSession::OpenMSRP

(

const PURL &

remoteUrl

)

PBoolean OpalMSRPMediaSession::ReadData	(	BYTE *	data,
		PINDEX	length,
		PINDEX &	read
	)

void OpalMSRPMediaSession::SetConnection

(

PSafePtr< OpalMSRPManager::Connection > &

conn

)

virtual bool OpalMSRPMediaSession::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.

void OpalMSRPMediaSession::SetRemoteURL ( const PURL &  url )

inline

References m_remoteUrl.

Referenced by OpalMSRPMediaStream::SetRemoteURL().

static const PCaselessString& OpalMSRPMediaSession::TCP_MSRP ( )

static

Referenced by GetSessionType().

virtual bool OpalMSRPMediaSession::WritePacket ( RTP_DataFrame &  frame )

virtual

Field Documentation

PSafePtr<OpalMSRPManager::Connection> OpalMSRPMediaSession::m_connectionPtr

bool OpalMSRPMediaSession::m_isOriginating

std::string OpalMSRPMediaSession::m_localMSRPSessionId

PURL OpalMSRPMediaSession::m_localUrl

Referenced by GetLocalURL().

OpalMSRPManager& OpalMSRPMediaSession::m_manager

Referenced by GetManager().

OpalTransportAddress OpalMSRPMediaSession::m_remoteAddress

PURL OpalMSRPMediaSession::m_remoteUrl

Referenced by GetRemoteURL(), and SetRemoteURL().

---

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

• msrp.h