sipxportlib  Version 3.3
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
OsServerTask Class Referenceabstract

#include <OsServerTask.h>

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

Public Member Functions

 OsServerTask (const UtlString &name="", void *pArg=NULL, const int maxRequestQMsgs=DEF_MAX_MSGS, const int priority=DEF_PRIO, const int options=DEF_OPTIONS, const int stackSize=DEF_STACKSIZE)
 Main constructor for OsServerTask. More...
 
virtual ~OsServerTask ()
 
virtual UtlBoolean handleMessage (OsMsg &rMsg)=0
 
virtual OsStatus postMessage (const OsMsg &rMsg, const OsTime &rTimeout=OsTime::OS_INFINITY, UtlBoolean sentFromISR=FALSE)
 
virtual void requestShutdown (void)
 
OsMsgQ * getMessageQueue ()
 

Static Public Attributes

static const int DEF_MAX_MSGS = OsMsgQ::DEF_MAX_MSGS
 

Protected Member Functions

virtual OsStatus receiveMessage (OsMsg *&rpMsg)
 
virtual OsStatus receiveMessage (OsMsg *&rpMsg, const OsTime &rTimeout)
 
virtual int run (void *pArg)
 

Protected Attributes

OsMsgQ mIncomingQ
 

Constructor & Destructor Documentation

OsServerTask ( const UtlString name = "",
void *  pArg = NULL,
const int  maxRequestQMsgs = DEF_MAX_MSGS,
const int  priority = DEF_PRIO,
const int  options = DEF_OPTIONS,
const int  stackSize = DEF_STACKSIZE 
)

Main constructor for OsServerTask.

Parameters
[in]name- the name of this OsServerTask
[in]pArg- argument that is passed to the new thread as a parameter of the thread run method.
[in]maxRequestQMsgs- defines the size of the request message queue.
[in]priority- the thread priority to use. high = 0, low = 255
[in]options- Thread execution options to set, such as whether to allow breakpoint debugging.
[in]stackSize- The stack size to use for this task.
~OsServerTask ( )
virtual

Member Function Documentation

UtlBoolean handleMessage ( OsMsg rMsg)
pure virtual

Implemented in OsNatAgentTask, and OsSysLogTask.

OsStatus postMessage ( const OsMsg rMsg,
const OsTime rTimeout = OsTime::OS_INFINITY,
UtlBoolean  sentFromISR = FALSE 
)
virtual
void requestShutdown ( void  )
virtual
OsMsgQ * getMessageQueue ( )
OsStatus receiveMessage ( OsMsg *&  rpMsg)
protectedvirtual
OsStatus receiveMessage ( OsMsg *&  rpMsg,
const OsTime rTimeout 
)
protectedvirtual
int run ( void *  pArg)
protectedvirtual

Member Data Documentation

const int DEF_MAX_MSGS = OsMsgQ::DEF_MAX_MSGS
static
OsMsgQ mIncomingQ
protected