sipxportlib  Version 3.3
Public Types | Public Member Functions | Static Public Attributes | List of all members
OsMsg Class Reference

#include <OsMsg.h>

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

Public Types

enum  MsgTypes {
  UNSPECIFIED = 0, OS_SHUTDOWN, OS_TIMER, OS_EVENT,
  PS_MSG, PHONE_APP, MP_TASK_MSG, MP_FLOWGRAPH_MSG,
  MP_RESOURCE_MSG, MP_RES_NOTF_MSG, MP_BUFFER_MSG, MI_NOTF_MSG,
  SIP_PROXY_STATE, TAO_MSG, TAO_EVENT, TAO_LISTENER_EVENT_MSG,
  PINGER_MSG, REFRESH_MSG, LINE_MGR_MSG, OS_SYSLOG,
  STREAMING_MSG, USER_START = 128
}
 

Public Member Functions

 OsMsg (const unsigned char msgType, const unsigned char msgSubType)
 
 OsMsg (const OsMsg &rOsMsg)
 
virtual OsMsgcreateCopy (void) const
 
virtual void releaseMsg (void)
 
virtual ~OsMsg ()
 
OsMsgoperator= (const OsMsg &rhs)
 
virtual void setMsgSubType (unsigned char subType)
 
virtual void setSentFromISR (UtlBoolean sentFromISR)
 
virtual void setReusable (UtlBoolean isReusable)
 
virtual void setInUse (UtlBoolean isInUse)
 
virtual unsigned char getMsgType (void) const
 
virtual unsigned char getMsgSubType (void) const
 
virtual int getMsgSize (void) const
 
virtual UtlBoolean getSentFromISR (void) const
 
virtual UtlBoolean isMsgReusable (void) const
 
virtual UtlBoolean isMsgInUse (void) const
 
virtual unsigned hash () const
 Implements the interface for a UtlContainable. More...
 
virtual UtlContainableType getContainableType () const
 
virtual int compareTo (UtlContainable const *) const
 Compare this object to another object. More...
 
- Public Member Functions inherited from UtlContainable
virtual ~UtlContainable ()
 
unsigned directHash () const
 Provides a hash function that uses the object pointer as the hash value. More...
 
virtual UtlBoolean isEqual (UtlContainable const *) const
 Test this object to another object for equality. More...
 
virtual UtlBoolean isInstanceOf (const UtlContainableType type) const
 Determine if this object is a derivative of the specified UtlContainableType. More...
 

Static Public Attributes

static const UtlContainableType TYPE = "OsMsg"
 enumcode: OS_SHUTDOWN - Task shutdown request message enumcode: OS_TIMER - Timer request messages enumcode: OS_EVENT - Event notification messages enumcode: PS_MSG - Phone set messages enumcode: PHONE_APP - Phone application class of messages enumcode: MP_TASK_MSG - Media processing task class of messages enumcode: MP_FLOWGRAPH_MSG - Media processing flowgraph class of messages enumcode: MP_RESOURCE_MSG - Media processing resource class of messages for new (2007-03) resource framework enumcode: MP_BUFFER_MSG - Media processing buffer queue messages enumcode: SIP_PROXY_STATE - SIP proxy call state message enumcode: OS_SYSLOG - OS SysLog Messages enumcode: USER_START - User defined message type categories start at USER_START More...
 
- Static Public Attributes inherited from UtlContainable
static const UtlContainableType TYPE = "UtlContainable"
 

Additional Inherited Members

- Static Public Member Functions inherited from UtlContainable
static unsigned stringHash (char const *value)
 Provides a hash function appropriate for null-terminated string values. More...
 
static UtlBoolean areSameTypes (const UtlContainableType type1, const UtlContainableType type2)
 Are UtlContainable types the same. More...
 

Member Enumeration Documentation

enum MsgTypes
Enumerator
UNSPECIFIED 
OS_SHUTDOWN 
OS_TIMER 
OS_EVENT 
PS_MSG 
PHONE_APP 
MP_TASK_MSG 
MP_FLOWGRAPH_MSG 
MP_RESOURCE_MSG 
MP_RES_NOTF_MSG 
MP_BUFFER_MSG 
MI_NOTF_MSG 
SIP_PROXY_STATE 
TAO_MSG 
TAO_EVENT 
TAO_LISTENER_EVENT_MSG 
PINGER_MSG 
REFRESH_MSG 
LINE_MGR_MSG 
OS_SYSLOG 
STREAMING_MSG 
USER_START 

Constructor & Destructor Documentation

OsMsg ( const unsigned char  msgType,
const unsigned char  msgSubType 
)

< Class type used for runtime checking

OsMsg ( const OsMsg rOsMsg)
~OsMsg ( )
virtual

Member Function Documentation

OsMsg * createCopy ( void  ) const
virtual
void releaseMsg ( void  )
virtual
OsMsg & operator= ( const OsMsg rhs)
void setMsgSubType ( unsigned char  subType)
virtual
void setSentFromISR ( UtlBoolean  sentFromISR)
virtual
void setReusable ( UtlBoolean  isReusable)
virtual
void setInUse ( UtlBoolean  isInUse)
virtual
unsigned char getMsgType ( void  ) const
virtual
unsigned char getMsgSubType ( void  ) const
virtual
int getMsgSize ( void  ) const
virtual

Reimplemented in OsTimerMsg, OsTimerMessage, OsRpcMsg, and OsEventMsg.

UtlBoolean getSentFromISR ( void  ) const
virtual
UtlBoolean isMsgReusable ( void  ) const
virtual
UtlBoolean isMsgInUse ( void  ) const
virtual
unsigned hash ( ) const
virtual

Implements the interface for a UtlContainable.

Implements UtlContainable.

UtlContainableType getContainableType ( ) const
virtual

Get the ContainableType for a UtlContainable-derived class.

Implements UtlContainable.

int compareTo ( UtlContainable const *  ) const
virtual

Compare this object to another object.

Results of comparison to an object not of the same UtlContainableType may be undefined.

Returns
0 if equal, < 0 if less then and >0 if greater.
Requirements
  • if A.compareTo(B) == 0 then B.compareTo(A) must be == 0
  • if A.compareTo(B) < 0 then B.compareTo(A) must be > 0
  • if A.compareTo(B) > 0 then B.compareTo(A) must be < 0
  • if A.compareTo(B) < 0 and B.compareTo(C) < 0 then A.compareTo(C) must be < 0 etc.

Results for comparing with a non-like object are undefined, other than that it must return non-equal. Note that a copy of an object might not compare equal to the original, unless the definition of its type requires it.

Implements UtlContainable.

Member Data Documentation

const UtlContainableType TYPE = "OsMsg"
static

enumcode: OS_SHUTDOWN - Task shutdown request message enumcode: OS_TIMER - Timer request messages enumcode: OS_EVENT - Event notification messages enumcode: PS_MSG - Phone set messages enumcode: PHONE_APP - Phone application class of messages enumcode: MP_TASK_MSG - Media processing task class of messages enumcode: MP_FLOWGRAPH_MSG - Media processing flowgraph class of messages enumcode: MP_RESOURCE_MSG - Media processing resource class of messages for new (2007-03) resource framework enumcode: MP_BUFFER_MSG - Media processing buffer queue messages enumcode: SIP_PROXY_STATE - SIP proxy call state message enumcode: OS_SYSLOG - OS SysLog Messages enumcode: USER_START - User defined message type categories start at USER_START