sipxportlib  Version 3.3
Public Types | Public Member Functions | List of all members
OsTimerMsg Class Reference

#include <OsTimerMsg.h>

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

Public Types

enum  MsgSubType { OS_TIMER_UPDATE, OS_TIMER_UPDATE_SYNC, OS_TIMER_UPDATE_DELETE, OS_TIMER_SHUTDOWN }
 
- Public Types inherited from OsRpcMsg
enum  OsRpcMsgType { REQUEST }
 
- Public Types inherited from OsMsg
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

 OsTimerMsg (const unsigned char subType, OsTimer *pTimer, OsEvent *pEvent)
 
 OsTimerMsg (const OsTimerMsg &rOsTimerMsg)
 
virtual OsMsgcreateCopy (void) const
 
virtual ~OsTimerMsg ()
 
OsTimerMsgoperator= (const OsTimerMsg &rhs)
 
virtual int getMsgSize (void) const
 
OsTimergetTimerP (void) const
 Return the (pointer to the OsTimer object) in this message. More...
 
OsEventgetEventP (void) const
 Return the (pointer to the OsEvent object) in this message. More...
 
- Public Member Functions inherited from OsRpcMsg
 OsRpcMsg (const unsigned char msgType, const unsigned char msgSubType, const OsEvent &rEvent)
 enumcode: Request - Message from client to server More...
 
 OsRpcMsg (const OsRpcMsg &rOsRpcMsg)
 
virtual ~OsRpcMsg ()
 
OsRpcMsgoperator= (const OsRpcMsg &rhs)
 
virtual OsEventgetEvent (void) const
 
- Public Member Functions inherited from OsMsg
 OsMsg (const unsigned char msgType, const unsigned char msgSubType)
 
 OsMsg (const OsMsg &rOsMsg)
 
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 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...
 

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...
 
- Static Public Attributes inherited from OsMsg
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"
 

Member Enumeration Documentation

enum MsgSubType
Enumerator
OS_TIMER_UPDATE 

update the status of the timer

OS_TIMER_UPDATE_SYNC 

update the status of the timer and signal an event object

OS_TIMER_UPDATE_DELETE 

update the status of the timer and delete it

OS_TIMER_SHUTDOWN 

shut down the timer task */

Constructor & Destructor Documentation

OsTimerMsg ( const unsigned char  subType,
OsTimer pTimer,
OsEvent pEvent 
)
OsTimerMsg ( const OsTimerMsg rOsTimerMsg)
~OsTimerMsg ( )
virtual

Member Function Documentation

OsMsg * createCopy ( void  ) const
virtual

Reimplemented from OsRpcMsg.

OsTimerMsg & operator= ( const OsTimerMsg rhs)
int getMsgSize ( void  ) const
virtual

Reimplemented from OsRpcMsg.

OsTimer* getTimerP ( void  ) const
inline

Return the (pointer to the OsTimer object) in this message.

OsEvent* getEventP ( void  ) const
inline

Return the (pointer to the OsEvent object) in this message.