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
struct	IsTarget

Public Member Functions
PINDEX	GetSize () const
	Indicate the number of notifiers in list. More...

bool	Add (const Notifier &handler)
	Add a notifier to the list. More...

bool	Remove (const Notifier &handler)
	Remove notifier from teh list. More...

bool	Contains (const Notifier &handler) const
	Determine if notifier is in list. More...

bool	IsEmpty () const
	Indicate notifier list is empty. 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
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () 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 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 __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

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

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>

bool PNotifierListTemplate< ParamType >::Add ( const Notifier & handler )

inline

Add a notifier to the list.

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

template<typename ParamType>

bool PNotifierListTemplate< ParamType >::Contains ( const Notifier & handler ) const

inline

Determine if notifier is in list.

template<typename ParamType>

PINDEX PNotifierListTemplate< ParamType >::GetSize ( ) const

inline

Indicate the number of notifiers in list.

template<typename ParamType>

bool PNotifierListTemplate< ParamType >::IsEmpty ( ) const

inline

Indicate notifier list is empty.

template<typename ParamType>

bool PNotifierListTemplate< ParamType >::operator()	(	PObject &	obj,
		ParamType	param
	)

inline

Execute all notifiers in the list.

template<typename ParamType>

bool 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:

notifier_ext.h

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename ParamType> class PNotifierListTemplate< ParamType >

Member Function Documentation

template<typename ParamType>
class PNotifierListTemplate< ParamType >