OpalMessagePtr Class Reference

Wrapper around the OpalMessage structure. More...

#include <opal.h>

Public Member Functions
	OpalMessagePtr (OpalMessageType type=OpalIndCommandError)
	~OpalMessagePtr ()
OpalMessageType	GetType () const
void	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 *	GetRegistrationInfo () 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...

Protected Attributes
OpalMessage *	m_message

Friends
class	OpalContext

Detailed Description

Wrapper around the OpalMessage structure.

Constructor & Destructor Documentation

OpalMessagePtr()

OpalMessagePtr::OpalMessagePtr

(

OpalMessageType

type = OpalIndCommandError

)

~OpalMessagePtr()

OpalMessagePtr::~OpalMessagePtr

(

)

Member Function Documentation

GetAnswerCall()

OpalParamAnswerCall* OpalMessagePtr::GetAnswerCall

(

)

const

Used by OpalCmdAnswerCall/OpalCmdAlerting.

GetCallCleared()

OpalStatusCallCleared* OpalMessagePtr::GetCallCleared

(

)

const

Used by OpalIndCallCleared.

GetCallSetUp()

OpalParamSetUpCall* OpalMessagePtr::GetCallSetUp

(

)

const

Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.

GetCallToken()

const char* OpalMessagePtr::GetCallToken

(

)

const

Used by OpalCmdHoldCall/OpalCmdRetrieveCall/OpalCmdStopRecording.

GetClearCall()

OpalParamCallCleared* OpalMessagePtr::GetClearCall

(

)

const

Used by OpalCmdClearCall.

GetCommandError()

const char* OpalMessagePtr::GetCommandError

(

)

const

Used by OpalIndCommandError.

GetGeneralParams()

OpalParamGeneral* OpalMessagePtr::GetGeneralParams

(

)

const

Used by OpalCmdSetGeneralParameters.

GetIncomingCall()

OpalStatusIncomingCall* OpalMessagePtr::GetIncomingCall

(

)

const

Used by OpalIndIncomingCall.

GetLineAppearance()

OpalStatusLineAppearance* OpalMessagePtr::GetLineAppearance

(

)

const

Used by OpalIndLineAppearance.

GetMediaStream()

OpalStatusMediaStream* OpalMessagePtr::GetMediaStream

(

)

const

Used by OpalIndMediaStream/OpalCmdMediaStream.

GetMessageWaiting()

OpalStatusMessageWaiting* OpalMessagePtr::GetMessageWaiting

(

)

const

Used by OpalIndMessageWaiting.

GetProtocolParams()

OpalParamProtocol* OpalMessagePtr::GetProtocolParams

(

)

const

Used by OpalCmdSetProtocolParameters.

GetRecording()

OpalParamRecording* OpalMessagePtr::GetRecording

(

)

const

Used by OpalCmdStartRecording.

GetRegistrationInfo()

OpalParamRegistration* OpalMessagePtr::GetRegistrationInfo

(

)

const

Used by OpalCmdRegistration.

GetRegistrationStatus()

OpalStatusRegistration* OpalMessagePtr::GetRegistrationStatus

(

)

const

Used by OpalIndRegistration.

GetSetUserData()

OpalParamSetUserData* OpalMessagePtr::GetSetUserData

(

)

const

Used by OpalCmdSetUserData.

GetTransferStatus()

OpalStatusTransferCall* OpalMessagePtr::GetTransferStatus

(

)

const

Used by OpalIndTransferCall.

GetType()

OpalMessageType OpalMessagePtr::GetType

(

)

const

GetUserInput()

OpalStatusUserInput* OpalMessagePtr::GetUserInput

(

)

const

Used by OpalIndUserInput/OpalCmdUserInput.

SetCallToken()

void OpalMessagePtr::SetCallToken

(

const char *

token

)

SetType()

void OpalMessagePtr::SetType

(

OpalMessageType

type

)

Friends And Related Function Documentation

OpalContext

friend class OpalContext

friend

Field Documentation

m_message

OpalMessage* OpalMessagePtr::m_message

protected

---

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

• opal.h