OpalMediaSession Class Reference

#include <mediasession.h>

Inheritance diagram for OpalMediaSession:

Collaboration diagram for OpalMediaSession:

Data Structures
struct	Init
	Initialisation information for constructing a session. More...

Public Types
typedef PList< PChannel >	Transport

Public Member Functions
virtual const PCaselessString &	GetSessionType () const =0
virtual bool	Open (const PString &localInterface, const OpalTransportAddress &remoteAddress, bool isMediaAddress)
virtual bool	IsOpen () const
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)
virtual void	AttachTransport (Transport &transport)
virtual Transport	DetachTransport ()
virtual OpalMediaStream *	CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)=0
virtual void	GetStatistics (OpalMediaStatistics &statistics, bool receiver) const
void	OfferCryptoSuite (const PString &cryptoSuite)
virtual OpalMediaCryptoKeyList &	GetOfferedCryptoKeys ()
virtual bool	ApplyCryptoKey (OpalMediaCryptoKeyList &keys, bool rx)
virtual bool	IsCryptoSecured (bool rx) const
OpalConnection &	GetConnection () const
unsigned	GetSessionID () const
const OpalMediaType &	GetMediaType () const
const PString &	GetLocalUsername () const
const PString &	GetLocalPassword () const
virtual void	SetRemoteUserPass (const PString &user, const PString &pass)

Protected Member Functions
	OpalMediaSession (const Init &init)

Protected Attributes
OpalConnection &	m_connection
unsigned	m_sessionId
OpalMediaType	m_mediaType
PString	m_localUsername
PString	m_localPassword
PString	m_remoteUsername
PString	m_remotePassword
OpalMediaCryptoKeyList	m_offeredCryptokeys

Detailed Description

Class for carrying media session information

Member Typedef Documentation

typedef PList<PChannel> OpalMediaSession::Transport

Constructor & Destructor Documentation

OpalMediaSession::OpalMediaSession ( const Init &  init )

protected

Member Function Documentation

virtual bool OpalMediaSession::ApplyCryptoKey ( OpalMediaCryptoKeyList &  keys, bool  rx  )

virtual

virtual void OpalMediaSession::AttachTransport ( Transport &  transport )

virtual

Reimplemented in OpalRTPSession.

virtual bool OpalMediaSession::Close ( )

virtual

Reimplemented in OpalMSRPMediaSession, and OpalRTPSession.

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

pure virtual

Implemented in OpalDummySession, and OpalRTPSession.

virtual Transport OpalMediaSession::DetachTransport ( )

virtual

Reimplemented in OpalRTPSession.

OpalConnection& OpalMediaSession::GetConnection ( ) const

inline

References m_connection.

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

virtual

Reimplemented in OpalDummySession, OpalMSRPMediaSession, and OpalRTPSession.

const PString& OpalMediaSession::GetLocalPassword ( ) const

inline

References m_localPassword.

const PString& OpalMediaSession::GetLocalUsername ( ) const

inline

References m_localUsername.

const OpalMediaType& OpalMediaSession::GetMediaType ( ) const

inline

References m_mediaType.

virtual OpalMediaCryptoKeyList& OpalMediaSession::GetOfferedCryptoKeys ( )

virtual

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

virtual

Reimplemented in OpalDummySession, OpalMSRPMediaSession, and OpalRTPSession.

unsigned OpalMediaSession::GetSessionID ( ) const

inline

References m_sessionId.

virtual const PCaselessString& OpalMediaSession::GetSessionType ( ) const

pure virtual

Implemented in OpalDummySession, OpalMSRPMediaSession, and OpalRTPSession.

virtual void OpalMediaSession::GetStatistics ( OpalMediaStatistics &  statistics, bool  receiver  ) const

virtual

Reimplemented in OpalRTPSession.

virtual bool OpalMediaSession::IsCryptoSecured ( bool  rx ) const

virtual

virtual bool OpalMediaSession::IsOpen ( ) const

virtual

Reimplemented in OpalDummySession, and OpalRTPSession.

void OpalMediaSession::OfferCryptoSuite

(

const PString &

cryptoSuite

)

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

virtual

Reimplemented in OpalDummySession, OpalMSRPMediaSession, and OpalRTPSession.

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

virtual

Reimplemented in OpalDummySession, OpalMSRPMediaSession, and OpalRTPSession.

virtual void OpalMediaSession::SetRemoteUserPass ( const PString &  user, const PString &  pass  )

virtual

Field Documentation

OpalConnection& OpalMediaSession::m_connection

protected

Referenced by GetConnection().

PString OpalMediaSession::m_localPassword

protected

Referenced by GetLocalPassword().

PString OpalMediaSession::m_localUsername

protected

Referenced by GetLocalUsername().

OpalMediaType OpalMediaSession::m_mediaType

protected

Referenced by GetMediaType().

OpalMediaCryptoKeyList OpalMediaSession::m_offeredCryptokeys

protected

PString OpalMediaSession::m_remotePassword

protected

PString OpalMediaSession::m_remoteUsername

protected

unsigned OpalMediaSession::m_sessionId

protected

Referenced by GetSessionID().

---

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

• mediasession.h