OpalMessagePtr Class Reference

Wrapper around the OpalMessage structure. More...

#include <opal.h>

Collaboration diagram for OpalMessagePtr:

Public Member Functions
	OpalMessagePtr (OpalMessageType type=OpalIndCommandError)
	~OpalMessagePtr ()
OpalMessageType	GetType () const
OpalMessagePtr &	SetType (OpalMessageType type)
const char *	GetCallToken () const
	Used by OpalCmdHoldCall/OpalCmdRetrieveCall/OpalCmdStopRecording. More...
void	SetCallToken (const char *token)
const char *	GetCommandError () const
	Used by OpalIndCommandError. More...
OpalParamGeneral *	GetGeneralParams () const
	Used by OpalCmdSetGeneralParameters. More...
OpalParamProtocol *	GetProtocolParams () const
	Used by OpalCmdSetProtocolParameters. More...
OpalParamRegistration *	GetRegistrationParams () const
	Used by OpalCmdRegistration. More...
OpalStatusRegistration *	GetRegistrationStatus () const
	Used by OpalIndRegistration. More...
OpalParamSetUpCall *	GetCallSetUp () const
	Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished. More...
OpalStatusIncomingCall *	GetIncomingCall () const
	Used by OpalIndIncomingCall. More...
OpalParamAnswerCall *	GetAnswerCall () const
	Used by OpalCmdAnswerCall/OpalCmdAlerting. More...
OpalStatusUserInput *	GetUserInput () const
	Used by OpalIndUserInput/OpalCmdUserInput. More...
OpalStatusMessageWaiting *	GetMessageWaiting () const
	Used by OpalIndMessageWaiting. More...
OpalStatusLineAppearance *	GetLineAppearance () const
	Used by OpalIndLineAppearance. More...
OpalStatusCallCleared *	GetCallCleared () const
	Used by OpalIndCallCleared. More...
OpalParamCallCleared *	GetClearCall () const
	Used by OpalCmdClearCall. More...
OpalStatusMediaStream *	GetMediaStream () const
	Used by OpalIndMediaStream/OpalCmdMediaStream. More...
OpalParamSetUserData *	GetSetUserData () const
	Used by OpalCmdSetUserData. More...
OpalParamRecording *	GetRecording () const
	Used by OpalCmdStartRecording. More...
OpalStatusTransferCall *	GetTransferStatus () const
	Used by OpalIndTransferCall. More...
OpalPresenceStatus *	GetPresenceStatus () const
	Used by OpalCmdAuthorisePresence/OpalCmdSubscribePresence/OpalIndPresenceChange/OpalCmdSetLocalPresence. More...
OpalInstantMessage *	GetInstantMessage () const
	Used by OpalCmdSendIM/OpalIndReceiveIM. More...
	operator OpalParamGeneral * () const
	operator OpalParamProtocol * () const
	operator OpalParamRegistration * () const
	operator OpalStatusRegistration * () const
	operator OpalParamSetUpCall * () const
	operator OpalStatusIncomingCall * () const
	operator OpalParamAnswerCall * () const
	operator OpalStatusUserInput * () const
	operator OpalStatusMessageWaiting * () const
	operator OpalStatusLineAppearance * () const
	operator OpalStatusCallCleared * () const
	operator OpalParamCallCleared * () const
	operator OpalStatusMediaStream * () const
	operator OpalParamSetUserData * () const
	operator OpalParamRecording * () const
	operator OpalStatusTransferCall * () const
	operator OpalPresenceStatus * () const
	operator OpalInstantMessage * () const

Protected Attributes
OpalMessage *	m_message

Friends
class	OpalContext

Detailed Description

Wrapper around the OpalMessage structure.

Constructor & Destructor Documentation

OpalMessagePtr::OpalMessagePtr

(

OpalMessageType

type = OpalIndCommandError

)

OpalMessagePtr::~OpalMessagePtr

(

)

Member Function Documentation

OpalParamAnswerCall* OpalMessagePtr::GetAnswerCall

(

)

const

Used by OpalCmdAnswerCall/OpalCmdAlerting.

Referenced by operator OpalParamAnswerCall *().

OpalStatusCallCleared* OpalMessagePtr::GetCallCleared

(

)

const

Used by OpalIndCallCleared.

Referenced by operator OpalStatusCallCleared *().

OpalParamSetUpCall* OpalMessagePtr::GetCallSetUp

(

)

const

Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.

Referenced by operator OpalParamSetUpCall *().

const char* OpalMessagePtr::GetCallToken

(

)

const

Used by OpalCmdHoldCall/OpalCmdRetrieveCall/OpalCmdStopRecording.

OpalParamCallCleared* OpalMessagePtr::GetClearCall

(

)

const

Used by OpalCmdClearCall.

Referenced by operator OpalParamCallCleared *().

const char* OpalMessagePtr::GetCommandError

(

)

const

Used by OpalIndCommandError.

OpalParamGeneral* OpalMessagePtr::GetGeneralParams

(

)

const

Used by OpalCmdSetGeneralParameters.

Referenced by operator OpalParamGeneral *().

OpalStatusIncomingCall* OpalMessagePtr::GetIncomingCall

(

)

const

Used by OpalIndIncomingCall.

Referenced by operator OpalStatusIncomingCall *().

OpalInstantMessage* OpalMessagePtr::GetInstantMessage

(

)

const

Used by OpalCmdSendIM/OpalIndReceiveIM.

Referenced by operator OpalInstantMessage *().

OpalStatusLineAppearance* OpalMessagePtr::GetLineAppearance

(

)

const

Used by OpalIndLineAppearance.

Referenced by operator OpalStatusLineAppearance *().

OpalStatusMediaStream* OpalMessagePtr::GetMediaStream

(

)

const

Used by OpalIndMediaStream/OpalCmdMediaStream.

Referenced by operator OpalStatusMediaStream *().

OpalStatusMessageWaiting* OpalMessagePtr::GetMessageWaiting

(

)

const

Used by OpalIndMessageWaiting.

Referenced by operator OpalStatusMessageWaiting *().

OpalPresenceStatus* OpalMessagePtr::GetPresenceStatus

(

)

const

Used by OpalCmdAuthorisePresence/OpalCmdSubscribePresence/OpalIndPresenceChange/OpalCmdSetLocalPresence.

Referenced by operator OpalPresenceStatus *().

OpalParamProtocol* OpalMessagePtr::GetProtocolParams

(

)

const

Used by OpalCmdSetProtocolParameters.

Referenced by operator OpalParamProtocol *().

OpalParamRecording* OpalMessagePtr::GetRecording

(

)

const

Used by OpalCmdStartRecording.

Referenced by operator OpalParamRecording *().

OpalParamRegistration* OpalMessagePtr::GetRegistrationParams

(

)

const

Used by OpalCmdRegistration.

Referenced by operator OpalParamRegistration *().

OpalStatusRegistration* OpalMessagePtr::GetRegistrationStatus

(

)

const

Used by OpalIndRegistration.

Referenced by operator OpalStatusRegistration *().

OpalParamSetUserData* OpalMessagePtr::GetSetUserData

(

)

const

Used by OpalCmdSetUserData.

Referenced by operator OpalParamSetUserData *().

OpalStatusTransferCall* OpalMessagePtr::GetTransferStatus

(

)

const

Used by OpalIndTransferCall.

Referenced by operator OpalStatusTransferCall *().

OpalMessageType OpalMessagePtr::GetType

(

)

const

OpalStatusUserInput* OpalMessagePtr::GetUserInput

(

)

const

Used by OpalIndUserInput/OpalCmdUserInput.

Referenced by operator OpalStatusUserInput *().

OpalMessagePtr::operator OpalInstantMessage * ( ) const

inline

References GetInstantMessage().

OpalMessagePtr::operator OpalParamAnswerCall * ( ) const

inline

References GetAnswerCall().

OpalMessagePtr::operator OpalParamCallCleared * ( ) const

inline

References GetClearCall().

OpalMessagePtr::operator OpalParamGeneral * ( ) const

inline

References GetGeneralParams().

OpalMessagePtr::operator OpalParamProtocol * ( ) const

inline

References GetProtocolParams().

OpalMessagePtr::operator OpalParamRecording * ( ) const

inline

References GetRecording().

OpalMessagePtr::operator OpalParamRegistration * ( ) const

inline

References GetRegistrationParams().

OpalMessagePtr::operator OpalParamSetUpCall * ( ) const

inline

References GetCallSetUp().

OpalMessagePtr::operator OpalParamSetUserData * ( ) const

inline

References GetSetUserData().

OpalMessagePtr::operator OpalPresenceStatus * ( ) const

inline

References GetPresenceStatus().

OpalMessagePtr::operator OpalStatusCallCleared * ( ) const

inline

References GetCallCleared().

OpalMessagePtr::operator OpalStatusIncomingCall * ( ) const

inline

References GetIncomingCall().

OpalMessagePtr::operator OpalStatusLineAppearance * ( ) const

inline

References GetLineAppearance().

OpalMessagePtr::operator OpalStatusMediaStream * ( ) const

inline

References GetMediaStream().

OpalMessagePtr::operator OpalStatusMessageWaiting * ( ) const

inline

References GetMessageWaiting().

OpalMessagePtr::operator OpalStatusRegistration * ( ) const

inline

References GetRegistrationStatus().

OpalMessagePtr::operator OpalStatusTransferCall * ( ) const

inline

References GetTransferStatus().

OpalMessagePtr::operator OpalStatusUserInput * ( ) const

inline

References GetUserInput().

void OpalMessagePtr::SetCallToken

(

const char *

token

)

OpalMessagePtr& OpalMessagePtr::SetType

(

OpalMessageType

type

)

Friends And Related Function Documentation

friend class OpalContext

friend

Field Documentation

OpalMessage* OpalMessagePtr::m_message

protected

---

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

• opal.h