PTLib  Version 2.14.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PNotifierListTemplate< ParamType > Class Template Reference

Maintain a list of notifiers to be called all at once. More...

#include <notifier_ext.h>

Inheritance diagram for PNotifierListTemplate< ParamType >:
Collaboration diagram for PNotifierListTemplate< ParamType >:

Classes

class  IsObj
 

Public Member Functions

PINDEX GetSize () const
 Indicate the number of notifiers in list. More...
 
void Add (const Notifier &handler)
 Add a notifier to the list. More...
 
void Remove (const Notifier &handler)
 Remove notifier from teh list. More...
 
void RemoveTarget (PObject *obj)
 Remove all notifiers that use the specified target object. More...
 
bool operator() (PObject &obj, ParamType param)
 Execute all notifiers in the list. More...
 
- Public Member Functions inherited from PObject
unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
void SetTraceContextIdentifier (unsigned id)
 
void GetTraceContextIdentifier (PObject &obj)
 
void GetTraceContextIdentifier (PObject *obj)
 
void SetTraceContextIdentifier (const PObject &obj)
 
void SetTraceContextIdentifier (const PObject *obj)
 
virtual ~PObject ()
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
template<class CLS >
CLS * CloneAs () const
 As for Clone() but converts to specified type. More...
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. More...
 
__inline const PObjectPTraceObjectInstance () const
 
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- Static Public Member Functions inherited from PObject
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
static const char * Class ()
 Get the name of the class as a C string. More...
 
static __inline const PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (const PObject *obj)
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 
- Friends inherited from PObject

Detailed Description

template<typename ParamType>
class PNotifierListTemplate< ParamType >

Maintain a list of notifiers to be called all at once.

Member Function Documentation

template<typename ParamType>
void PNotifierListTemplate< ParamType >::Add ( const Notifier handler)
inline

Add a notifier to the list.

Referenced by XMPP::BaseStreamHandler::AddNotifier().

template<typename ParamType>
PINDEX PNotifierListTemplate< ParamType >::GetSize ( ) const
inline

Indicate the number of notifiers in list.

template<typename ParamType>
bool PNotifierListTemplate< ParamType >::operator() ( PObject obj,
ParamType  param 
)
inline

Execute all notifiers in the list.

template<typename ParamType>
void PNotifierListTemplate< ParamType >::Remove ( const Notifier handler)
inline

Remove notifier from teh list.

template<typename ParamType>
void PNotifierListTemplate< ParamType >::RemoveTarget ( PObject obj)
inline

Remove all notifiers that use the specified target object.


The documentation for this class was generated from the following file: