sipXcallLib home page


Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | List of all members
PtEventListener Class Reference

#include <PtEventListener.h>

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

Public Member Functions

PT_CLASS_INFO_MEMBERS PtEventListener (PtEventMask *pMask=NULL)
 
virtual ~PtEventListener ()
 param: (in) pMask - Event mask defining events the listener is interested in. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest. More...
 
PtStatus getEventMask (const PtEventMask *&rpMask) const
 
virtual PtBoolean isClass (const char *pClassName)
 
virtual PtBoolean isInstanceOf (const char *pClassName)
 param: (in) pClassName - The string to compare with the name of this class. retcode: TRUE - If the given string contains the class name of this class retcode: FALSE - If the given string does not match that of this class More...
 
PtBoolean isEventEnabled (PtEvent::PtEventId &eventId)
 param: (in) pClassName - The string to compare with the name of this class retcode: TRUE - If this object is either an instance of or is derived from the specified class retcode: FALSE - If this object is not an instance of the specified class More...
 

Static Public Member Functions

static const char * className ()
 param: (out) rpMask - Reference to a pointer to the PtEventMask. retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 

Protected Attributes

PtEventMaskmpMask
 param: (in) eventId - The event id corresponding to the event type retcode: TRUE - If the given event type is of interest to this listener retcode: FALSE - If the given event type is NOT of interest to this listener More...
 

Private Member Functions

 PtEventListener (const PtEventListener &rPtEventListener)
 
PtEventListeneroperator= (const PtEventListener &rhs)
 

Constructor & Destructor Documentation

PtEventListener ( PtEventMask pMask = NULL)
~PtEventListener ( )
virtual

param: (in) pMask - Event mask defining events the listener is interested in. This must be a subset of the events that the listener supports. The mask may be NULL where it is assumed that all events applicable to the derived listener are of interest.

PtEventListener ( const PtEventListener rPtEventListener)
private

Member Function Documentation

static const char* className ( )
static

param: (out) rpMask - Reference to a pointer to the PtEventMask. retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getEventMask ( const PtEventMask *&  rpMask) const
virtual PtBoolean isClass ( const char *  pClassName)
virtual
PtBoolean isEventEnabled ( PtEvent::PtEventId eventId)

param: (in) pClassName - The string to compare with the name of this class retcode: TRUE - If this object is either an instance of or is derived from the specified class retcode: FALSE - If this object is not an instance of the specified class

virtual PtBoolean isInstanceOf ( const char *  pClassName)
virtual

param: (in) pClassName - The string to compare with the name of this class. retcode: TRUE - If the given string contains the class name of this class retcode: FALSE - If the given string does not match that of this class

Reimplemented in PtCallListener, PtTerminalComponentListener, PtConnectionListener, PtTerminalConnectionListener, and PtTerminalListener.

PtEventListener & operator= ( const PtEventListener rhs)
private

Member Data Documentation

PtEventMask* mpMask
protected

param: (in) eventId - The event id corresponding to the event type retcode: TRUE - If the given event type is of interest to this listener retcode: FALSE - If the given event type is NOT of interest to this listener