sipXcallLib home page


Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
TaoMessage Class Reference

#include <TaoMessage.h>

Inheritance diagram for TaoMessage:
Inheritance graph
[legend]
Collaboration diagram for TaoMessage:
Collaboration graph
[legend]

Public Types

enum  TaoMsgTypes {
  UNSPECIFIED = 0, REQUEST_ADDRESS = 1, REQUEST_CALL, REQUEST_CONNECTION,
  REQUEST_PROVIDER, REQUEST_TERMCONNECTION, REQUEST_TERMINAL, REQUEST_PHONEBUTTTON,
  REQUEST_PHONECOMPONENT, RESPONSE_ADDRESS = 9, RESPONSE_CALL, RESPONSE_CONNECTION,
  RESPONSE_PROVIDER, RESPONSE_TERMCONNECTION, RESPONSE_TERMINAL, RESPONSE_PHONEBUTTTON,
  RESPONSE_PHONECOMPONENT, EVENT = 17, TAO_CREATE_CALL = 18, TAO_CALL_CONNECT,
  TAO_CALL_DROP
}
 
enum  TaoMsgCmds {
  ADD_PROVIDER_LISTENER = 0x00, CREATE_CALL = 0x01, CREATE_CALL_RESULT = 0x02, GET_ADDRESS = 0x03,
  GET_ADDRESSES = 0x04, GET_CALLS = 0x05, GET_CONNECTION = 0x06, GET_PROVIDER = 0x07,
  GET_PROVIDER_LISTENERS = 0x08, GET_STATE = 0x09, GET_TERM_CONNECTION = 0x0a, GET_TERMINAL = 0x0b,
  GET_TERMINALS = 0x0c, NUM_ADDRESSES = 0x0d, NUM_CALLS = 0x0e, NUM_PROVIDER_LISTENERS = 0x0f,
  NUM_TERMINALS = 0x10, REMOVE_PROVIDER_LISTENER = 0x11, SHUTDOWN = 0x12, ADD_ADDRESS_LISTENER = 0x20,
  ADD_CALL_LISTENER = 0x21, CANCEL_FORWARDING = 0x22, CANCEL_ALL_FORWARDING = 0x23, GET_ADDRESS_LISTENERS = 0x24,
  GET_CALL_LISTENERS = 0x25, GET_CONNECTIONS = 0x26, GET_DONOT_DISTURB = 0x27, GET_FORWARDING = 0x28,
  GET_MESSAGE_WAITING = 0x29, GET_NAME = 0x2a, GET_OFFERED_TIMEOUT = 0x2b, NUM_ADDRESS_LISTENERS = 0x2c,
  NUM_CALL_LISTENERS = 0x2d, NUM_CONNECTIONS = 0x2e, NUM_FORWARDS = 0x2f, REMOVE_ADDRESS_LISTENER = 0x30,
  REMOVE_CALL_LISTENER = 0x31, SET_DONOT_DISTURB = 0x32, SET_FORWARDING = 0x33, SET_MESSAGE_WAITING = 0x34,
  SET_OFFERED_TIMEOUT = 0x36, ADD_PARTY = 0x40, CONFERENCE = 0x41, CONNECT = 0x42,
  CONNECT_RESULT = 0x43, CONSULT = 0x44, DROP = 0x45, DROP_RESULT = 0x46,
  GET_CALLED_ADDRESS = 0x47, GET_CALLING_ADDRESS = 0x48, GET_CALLING_TERMINAL = 0x49, GET_CONF_CONTROLLER = 0x4a,
  GET_LAST_REDIRECTED_ADDRESS = 0x4b, GET_TRANSFER_CONTROLLER = 0x4c, NUM_CALLLISTENERS = 0x4d, SET_CONF_CONTROLLER = 0x4e,
  SET_TRANSFER_CONTROLLER = 0x4f, TRANSFER_CON = 0x50, TRANSFER_SEL = 0x51, CALL_HOLD = 0x52,
  CALL_UNHOLD = 0x53, GET_CODEC_CPU_LIMIT = 0x54, SET_CODEC_CPU_LIMIT = 0x55, GET_CODEC_CPU_COST = 0x56,
  CODEC_RENEGOTIATE = 0x57, ACCEPT = 0x60, DISCONNECT = 0x61, GET_CALL = 0x62,
  GET_TERM_CONNECTIONS = 0x63, NUM_TERM_CONNECTIONS = 0x64, PARK = 0x65, REDIRECT = 0x66,
  REJECT = 0x67, GET_FROM_FIELD = 0x68, GET_TO_FIELD = 0x69, GET_SESSION_INFO = 0x6a,
  ANSWER = 0x70, HOLD = 0x71, UNHOLD = 0x72, PLAY_FILE_NAME = 0x73,
  PLAY_FILE_URL = 0x74, START_TONE = 0x75, STOP_TONE = 0x76, STOP_PLAY = 0x77,
  IS_LOCAL = 0x78, CREATE_PLAYER = 0x79, DESTROY_PLAYER = 0x7A, CREATE_PLAYLIST_PLAYER = 0x7B,
  DESTROY_PLAYLIST_PLAYER = 0x7C, ADD_TERM_LISTENER = 0x80, GET_COMPONENT = 0x81, GET_COMPONENTS = 0x82,
  GET_COMPONENTGROUPS = 0x83, GET_CONFIG = 0x84, GET_TERM_LISTENERS = 0x85, NUM_COMPONENTS = 0x86,
  NUM_TERM_LISTENERS = 0x87, PICKUP = 0x88, REMOVE_TERM_LISTENER = 0x89, TERMINAL_RESULT = 0x8a,
  SET_INBOUND_CODEC_CPU_LIMIT = 0x8b, BUTTON_PRESS = 0x90, BUTTON_DOWN = 0x91, BUTTON_UP = 0x92,
  BUTTON_GET_INFO = 0x93, BUTTON_SET_INFO = 0x94, BUTTON_GET_PHONELAMP = 0x95, HOOKSWITCH_SET_STATE = 0xa0,
  HOOKSWITCH_GET_STATE = 0xa1, HOOKSWITCH_GET_CALL = 0xa2, LAMP_GET_MODE = 0xb0, LAMP_GET_SUPPORTED_MODES = 0xb1,
  LAMP_GET_BUTTON = 0xb2, LAMP_SET_MODE = 0xb3, DISPLAY_GET_DISPLAY = 0xb4, DISPLAY_GET_ROWS = 0xb5,
  DISPLAY_GET_COLS = 0xb6, DISPLAY_GET_CONTRAST = 0xb7, DISPLAY_SET_DISPLAY = 0xb8, DISPLAY_SET_CONTRAST = 0xb9,
  MIC_GET_GAIN = 0xc0, MIC_SET_GAIN = 0xc1, RINGER_SET_INFO = 0xc2, RINGER_SET_PATTERN = 0xc3,
  RINGER_SET_VOLUME = 0xc4, RINGER_GET_INFO = 0xc5, RINGER_GET_PATTERN = 0xc6, RINGER_GET_VOLUME = 0xc7,
  RINGER_GET_MAX_PATTERN_INDEX = 0xc8, RINGER_GET_NUMBER_OF_RINGS = 0xc9, RINGER_IS_ON = 0xca, SPEAKER_SET_VOLUME = 0xcb,
  SPEAKER_GET_VOLUME = 0xcc, SPEAKER_GET_NOMINAL_VOLUME = 0xcd, PHONEGROUP_ACTIVATE = 0xd0, PHONEGROUP_DEACTIVATE = 0xd1,
  PHONEGROUP_GET_COMPONENTS = 0xd2, PHONEGROUP_GET_DESCRIPTION = 0xd3, PHONEGROUP_GET_TYPE = 0xd4, PHONEGROUP_IS_ACTIVATED = 0xd5,
  EXTSPEAKER_SET_VOLUME = 0xd6, EXTSPEAKER_GET_VOLUME = 0xd7, EXTSPEAKER_GET_NOMINAL_VOLUME = 0xd8, COMPONENT_RESULT = 0xd9
}
 

Public Member Functions

 TaoMessage ()
 
 TaoMessage (const UtlString &msgString)
 
 TaoMessage (UtlString &msgString, UtlString delimiter)
 
 TaoMessage (const unsigned char msgType, const unsigned char cmd, const int msgId, TaoObjHandle handle, TaoObjHandle socket, const int argCnt, const UtlString &agrList)
 
 TaoMessage (TaoListenerEventMessage &rEventMessage, TaoObjHandle hSocket)
 
 TaoMessage (const TaoMessage &rTaoMessage)
 
 TaoMessage (OsMsg &msgString)
 
virtual OsMsg * createCopy (void) const
 
virtual ~TaoMessage ()
 
TaoMessageoperator= (const TaoMessage &rhs)
 
void setCmd (TaoMsgCmds cmd)
 
void setSocket (TaoObjHandle handle)
 
void setMsgID (unsigned int id)
 
void setArgCnt (int cnt)
 
void setArgList (UtlString &argList)
 
void setArgList (const char *szArgList)
 
void setObjHandle (TaoObjHandle handle)
 
void setMsgQueueHandle (TaoObjHandle handle)
 
TaoObjHandle getMsgQueueHandle (void) const
 
TaoObjHandle getSocket (void) const
 
unsigned int getMsgID (void) const
 
TaoObjHandle getTaoObjHandle (void) const
 
unsigned int getArgCnt (void) const
 
const char * getArgList (void) const
 
unsigned char getCmd ()
 
void getBytes (UtlString *bytes, int *length)
 

Protected Member Functions

void createHTTPMsg (TaoMessage &rTaoMessage)
 param: bytes - gets allocated and must be freed param: length - the length of bytes More...
 

Private Member Functions

void serialize ()
 
void deSerialize ()
 

Private Attributes

TaoObjHandle mTaoObjHandle
 
TaoObjHandle mSocketHandle
 
TaoObjHandle mMessageQueueHandle
 
unsigned int mMsgID
 
unsigned int mArgCnt
 
UtlString mArgList
 
UtlBoolean mbDirty
 
unsigned char mCmd
 
int mBodyLength
 
UtlString mBody
 

Member Enumeration Documentation

enum TaoMsgCmds
Enumerator
ADD_PROVIDER_LISTENER 
CREATE_CALL 
CREATE_CALL_RESULT 
GET_ADDRESS 
GET_ADDRESSES 
GET_CALLS 
GET_CONNECTION 
GET_PROVIDER 
GET_PROVIDER_LISTENERS 
GET_STATE 
GET_TERM_CONNECTION 
GET_TERMINAL 
GET_TERMINALS 
NUM_ADDRESSES 
NUM_CALLS 
NUM_PROVIDER_LISTENERS 
NUM_TERMINALS 
REMOVE_PROVIDER_LISTENER 
SHUTDOWN 
ADD_ADDRESS_LISTENER 
ADD_CALL_LISTENER 
CANCEL_FORWARDING 
CANCEL_ALL_FORWARDING 
GET_ADDRESS_LISTENERS 
GET_CALL_LISTENERS 
GET_CONNECTIONS 
GET_DONOT_DISTURB 
GET_FORWARDING 
GET_MESSAGE_WAITING 
GET_NAME 
GET_OFFERED_TIMEOUT 
NUM_ADDRESS_LISTENERS 
NUM_CALL_LISTENERS 
NUM_CONNECTIONS 
NUM_FORWARDS 
REMOVE_ADDRESS_LISTENER 
REMOVE_CALL_LISTENER 
SET_DONOT_DISTURB 
SET_FORWARDING 
SET_MESSAGE_WAITING 
SET_OFFERED_TIMEOUT 
ADD_PARTY 
CONFERENCE 
CONNECT 
CONNECT_RESULT 
CONSULT 
DROP 
DROP_RESULT 
GET_CALLED_ADDRESS 
GET_CALLING_ADDRESS 
GET_CALLING_TERMINAL 
GET_CONF_CONTROLLER 
GET_LAST_REDIRECTED_ADDRESS 
GET_TRANSFER_CONTROLLER 
NUM_CALLLISTENERS 
SET_CONF_CONTROLLER 
SET_TRANSFER_CONTROLLER 
TRANSFER_CON 
TRANSFER_SEL 
CALL_HOLD 
CALL_UNHOLD 
GET_CODEC_CPU_LIMIT 
SET_CODEC_CPU_LIMIT 
GET_CODEC_CPU_COST 
CODEC_RENEGOTIATE 
ACCEPT 
DISCONNECT 
GET_CALL 
GET_TERM_CONNECTIONS 
NUM_TERM_CONNECTIONS 
PARK 
REDIRECT 
REJECT 
GET_FROM_FIELD 
GET_TO_FIELD 
GET_SESSION_INFO 
ANSWER 
HOLD 
UNHOLD 
PLAY_FILE_NAME 
PLAY_FILE_URL 
START_TONE 
STOP_TONE 
STOP_PLAY 
IS_LOCAL 
CREATE_PLAYER 
DESTROY_PLAYER 
CREATE_PLAYLIST_PLAYER 
DESTROY_PLAYLIST_PLAYER 
ADD_TERM_LISTENER 
GET_COMPONENT 
GET_COMPONENTS 
GET_COMPONENTGROUPS 
GET_CONFIG 
GET_TERM_LISTENERS 
NUM_COMPONENTS 
NUM_TERM_LISTENERS 
PICKUP 
REMOVE_TERM_LISTENER 
TERMINAL_RESULT 
SET_INBOUND_CODEC_CPU_LIMIT 
BUTTON_PRESS 
BUTTON_DOWN 
BUTTON_UP 
BUTTON_GET_INFO 
BUTTON_SET_INFO 
BUTTON_GET_PHONELAMP 
HOOKSWITCH_SET_STATE 
HOOKSWITCH_GET_STATE 
HOOKSWITCH_GET_CALL 
LAMP_GET_MODE 
LAMP_GET_SUPPORTED_MODES 
LAMP_GET_BUTTON 
LAMP_SET_MODE 
DISPLAY_GET_DISPLAY 
DISPLAY_GET_ROWS 
DISPLAY_GET_COLS 
DISPLAY_GET_CONTRAST 
DISPLAY_SET_DISPLAY 
DISPLAY_SET_CONTRAST 
MIC_GET_GAIN 
MIC_SET_GAIN 
RINGER_SET_INFO 
RINGER_SET_PATTERN 
RINGER_SET_VOLUME 
RINGER_GET_INFO 
RINGER_GET_PATTERN 
RINGER_GET_VOLUME 
RINGER_GET_MAX_PATTERN_INDEX 
RINGER_GET_NUMBER_OF_RINGS 
RINGER_IS_ON 
SPEAKER_SET_VOLUME 
SPEAKER_GET_VOLUME 
SPEAKER_GET_NOMINAL_VOLUME 
PHONEGROUP_ACTIVATE 
PHONEGROUP_DEACTIVATE 
PHONEGROUP_GET_COMPONENTS 
PHONEGROUP_GET_DESCRIPTION 
PHONEGROUP_GET_TYPE 
PHONEGROUP_IS_ACTIVATED 
EXTSPEAKER_SET_VOLUME 
EXTSPEAKER_GET_VOLUME 
EXTSPEAKER_GET_NOMINAL_VOLUME 
COMPONENT_RESULT 
Enumerator
UNSPECIFIED 
REQUEST_ADDRESS 
REQUEST_CALL 
REQUEST_CONNECTION 
REQUEST_PROVIDER 
REQUEST_TERMCONNECTION 
REQUEST_TERMINAL 
REQUEST_PHONEBUTTTON 
REQUEST_PHONECOMPONENT 
RESPONSE_ADDRESS 
RESPONSE_CALL 
RESPONSE_CONNECTION 
RESPONSE_PROVIDER 
RESPONSE_TERMCONNECTION 
RESPONSE_TERMINAL 
RESPONSE_PHONEBUTTTON 
RESPONSE_PHONECOMPONENT 
EVENT 
TAO_CREATE_CALL 
TAO_CALL_CONNECT 
TAO_CALL_DROP 

Constructor & Destructor Documentation

TaoMessage ( const UtlString &  msgString)
TaoMessage ( UtlString &  msgString,
UtlString  delimiter 
)
TaoMessage ( const unsigned char  msgType,
const unsigned char  cmd,
const int  msgId,
TaoObjHandle  handle,
TaoObjHandle  socket,
const int  argCnt,
const UtlString &  agrList 
)
TaoMessage ( TaoListenerEventMessage rEventMessage,
TaoObjHandle  hSocket 
)
TaoMessage ( const TaoMessage rTaoMessage)
TaoMessage ( OsMsg &  msgString)
~TaoMessage ( )
virtual

Member Function Documentation

OsMsg * createCopy ( void  ) const
virtual
void createHTTPMsg ( TaoMessage rTaoMessage)
protected

param: bytes - gets allocated and must be freed param: length - the length of bytes

void deSerialize ( )
private
unsigned int getArgCnt ( void  ) const
inline
const char* getArgList ( void  ) const
inline
void getBytes ( UtlString *  bytes,
int *  length 
)
unsigned char getCmd ( )
inline
unsigned int getMsgID ( void  ) const
inline
TaoObjHandle getMsgQueueHandle ( void  ) const
inline
TaoObjHandle getSocket ( void  ) const
inline
TaoObjHandle getTaoObjHandle ( void  ) const
inline
TaoMessage & operator= ( const TaoMessage rhs)
void serialize ( )
private
void setArgCnt ( int  cnt)
void setArgList ( UtlString &  argList)
void setArgList ( const char *  szArgList)
void setCmd ( TaoMsgCmds  cmd)
void setMsgID ( unsigned int  id)
void setMsgQueueHandle ( TaoObjHandle  handle)
void setObjHandle ( TaoObjHandle  handle)
void setSocket ( TaoObjHandle  handle)

Member Data Documentation

unsigned int mArgCnt
private
UtlString mArgList
private
UtlBoolean mbDirty
private
UtlString mBody
private
int mBodyLength
private
unsigned char mCmd
private
TaoObjHandle mMessageQueueHandle
private
unsigned int mMsgID
private
TaoObjHandle mSocketHandle
private
TaoObjHandle mTaoObjHandle
private