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

#include <OsProtectEvent.h>

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

Public Member Functions

 OsProtectedEvent (const intptr_t userData=0)
 
virtual ~OsProtectedEvent ()
 
virtual OsStatus signal (const intptr_t eventData)
 Set the event data and signal the occurrence of the event. More...
 
virtual OsStatus reset (void)
 Reset the event so that it may be signaled again. More...
 
virtual OsStatus wait (int msgId, const OsTime &rTimeout=OsTime::OS_INFINITY)
 
void setStringData (UtlString &rStringData)
 
void setIntData (intptr_t rIntData)
 
void setIntData2 (intptr_t rIntData)
 
void setInUse (UtlBoolean inUse)
 
OsStatus getStringData (UtlString &data)
 
OsStatus getIntData (intptr_t &data)
 
OsStatus getIntData2 (intptr_t &data)
 
virtual UtlBoolean isInUse ()
 
- Public Member Functions inherited from OsEvent
 OsEvent (const intptr_t userData=0)
 Constructor. More...
 
virtual ~OsEvent ()
 Destructor. More...
 
virtual OsStatus wait (const OsTime &rTimeout=OsTime::OS_INFINITY)
 Wait for the event to be signaled. More...
 
virtual OsStatus setUserData (intptr_t userData)
 Sets the user data specified. There are situations (such as the OsProtedtedEvent) More...
 
virtual OsStatus getEventData (intptr_t &rEventData)
 Return the event data that was signaled by the notifier task. More...
 
virtual OsStatus getUserData (intptr_t &rUserData) const
 Return the user data specified when this object was constructed. More...
 
virtual UtlBoolean isSignaled (void)
 Return TRUE if the event has been signaled, otherwise FALSE. More...
 
- Public Member Functions inherited from OsNotification
 OsNotification ()
 
virtual ~OsNotification ()
 
virtual void setTimeout (const OsTime &signalTimeout)
 Set timeout to use when signalling if supported by derived class. More...
 

Additional Inherited Members

- Protected Attributes inherited from OsNotification
OsTime mSignalTimeout
 Used by derived classes that support a timeout on signal. More...
 

Constructor & Destructor Documentation

OsProtectedEvent ( const intptr_t  userData = 0)
~OsProtectedEvent ( )
virtual

Member Function Documentation

OsStatus signal ( const intptr_t  eventData)
virtual

Set the event data and signal the occurrence of the event.

Return OS_ALREADY_SIGNALED if the event has already been signaled (and has not yet been cleared), otherwise return OS_SUCCESS.

Reimplemented from OsEvent.

OsStatus reset ( void  )
virtual

Reset the event so that it may be signaled again.

Return OS_NOT_SIGNALED if the event has not been signaled (or has already been cleared), otherwise return OS_SUCCESS.

Reimplemented from OsEvent.

OsStatus wait ( int  msgId,
const OsTime rTimeout = OsTime::OS_INFINITY 
)
virtual
void setStringData ( UtlString rStringData)
void setIntData ( intptr_t  rIntData)
void setIntData2 ( intptr_t  rIntData)
void setInUse ( UtlBoolean  inUse)
OsStatus getStringData ( UtlString data)
OsStatus getIntData ( intptr_t data)
OsStatus getIntData2 ( intptr_t data)
UtlBoolean isInUse ( )
virtual