OPAL  Version 3.12.9
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
 
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...
 
OpalParamGeneralGetGeneralParams () const
 Used by OpalCmdSetGeneralParameters. More...
 
OpalParamProtocolGetProtocolParams () const
 Used by OpalCmdSetProtocolParameters. More...
 
OpalParamRegistrationGetRegistrationInfo () const
 Used by OpalCmdRegistration. More...
 
OpalStatusRegistrationGetRegistrationStatus () const
 Used by OpalIndRegistration. More...
 
OpalParamSetUpCallGetCallSetUp () const
 Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished. More...
 
OpalStatusIncomingCallGetIncomingCall () const
 Used by OpalIndIncomingCall. More...
 
OpalParamAnswerCallGetAnswerCall () const
 Used by OpalCmdAnswerCall/OpalCmdAlerting. More...
 
OpalStatusUserInput * GetUserInput () const
 Used by OpalIndUserInput/OpalCmdUserInput. More...
 
OpalStatusMessageWaitingGetMessageWaiting () const
 Used by OpalIndMessageWaiting. More...
 
OpalStatusLineAppearanceGetLineAppearance () const
 Used by OpalIndLineAppearance. More...
 
OpalStatusCallClearedGetCallCleared () const
 Used by OpalIndCallCleared. More...
 
OpalParamCallClearedGetClearCall () const
 Used by OpalCmdClearCall. More...
 
OpalStatusMediaStreamGetMediaStream () const
 Used by OpalIndMediaStream/OpalCmdMediaStream. More...
 
OpalParamSetUserDataGetSetUserData () const
 Used by OpalCmdSetUserData. More...
 
OpalParamRecordingGetRecording () const
 Used by OpalCmdStartRecording. More...
 
OpalStatusTransferCallGetTransferStatus () const
 Used by OpalIndTransferCall. More...
 
OpalPresenceStatusGetPresenceStatus () const
 Used by OpalCmdAuthorisePresence/OpalCmdSubscribePresence/OpalIndPresenceChange/OpalCmdSetLocalPresence. More...
 
OpalInstantMessageGetInstantMessage () const
 Used by OpalCmdSendIM/OpalIndReceiveIM. More...
 

Protected Attributes

OpalMessagem_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.

OpalStatusCallCleared* OpalMessagePtr::GetCallCleared ( ) const

Used by OpalIndCallCleared.

OpalParamSetUpCall* OpalMessagePtr::GetCallSetUp ( ) const

Used by OpalCmdSetUpCall/OpalIndProceeding/OpalIndAlerting/OpalIndEstablished.

const char* OpalMessagePtr::GetCallToken ( ) const

Used by OpalCmdHoldCall/OpalCmdRetrieveCall/OpalCmdStopRecording.

OpalParamCallCleared* OpalMessagePtr::GetClearCall ( ) const

Used by OpalCmdClearCall.

const char* OpalMessagePtr::GetCommandError ( ) const

Used by OpalIndCommandError.

OpalParamGeneral* OpalMessagePtr::GetGeneralParams ( ) const

Used by OpalCmdSetGeneralParameters.

OpalStatusIncomingCall* OpalMessagePtr::GetIncomingCall ( ) const

Used by OpalIndIncomingCall.

OpalInstantMessage* OpalMessagePtr::GetInstantMessage ( ) const

Used by OpalCmdSendIM/OpalIndReceiveIM.

OpalStatusLineAppearance* OpalMessagePtr::GetLineAppearance ( ) const

Used by OpalIndLineAppearance.

OpalStatusMediaStream* OpalMessagePtr::GetMediaStream ( ) const

Used by OpalIndMediaStream/OpalCmdMediaStream.

OpalStatusMessageWaiting* OpalMessagePtr::GetMessageWaiting ( ) const

Used by OpalIndMessageWaiting.

OpalPresenceStatus* OpalMessagePtr::GetPresenceStatus ( ) const

Used by OpalCmdAuthorisePresence/OpalCmdSubscribePresence/OpalIndPresenceChange/OpalCmdSetLocalPresence.

OpalParamProtocol* OpalMessagePtr::GetProtocolParams ( ) const

Used by OpalCmdSetProtocolParameters.

OpalParamRecording* OpalMessagePtr::GetRecording ( ) const

Used by OpalCmdStartRecording.

OpalParamRegistration* OpalMessagePtr::GetRegistrationInfo ( ) const

Used by OpalCmdRegistration.

OpalStatusRegistration* OpalMessagePtr::GetRegistrationStatus ( ) const

Used by OpalIndRegistration.

OpalParamSetUserData* OpalMessagePtr::GetSetUserData ( ) const

Used by OpalCmdSetUserData.

OpalStatusTransferCall* OpalMessagePtr::GetTransferStatus ( ) const

Used by OpalIndTransferCall.

OpalMessageType OpalMessagePtr::GetType ( ) const
OpalStatusUserInput* OpalMessagePtr::GetUserInput ( ) const

Used by OpalIndUserInput/OpalCmdUserInput.

void OpalMessagePtr::SetCallToken ( const char *  token)
void 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: