This class defines a thread-safe array of objects. More...

#include <safecoll.h>

Inheritance diagram for PSafeDictionary< K, D >:

Collaboration diagram for PSafeDictionary< K, D >:

Classes
class	const_iterator

class	iterator

class	iterator_base

class	iterator_pair

Public Types
typedef K	key_type

typedef D	data_type

typedef PSafePtr< D >	value_type

typedef PSafeDictionary< K, D >	dict_type

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Public Member Functions
Iterators
iterator	begin ()

iterator	end ()

iterator	find (const K &key)

const_iterator	begin () const

const_iterator	end () const

const_iterator	find (const K &key) const

void	erase (const iterator &it)

void	erase (const const_iterator &it)

Public Member Functions inherited from PSafeDictionaryBase< PDictionary< K, D >, K, D >
	PSafeDictionaryBase ()
	Create a safe dictionary wrapper around the real collection. More...

	PSafeDictionaryBase (const PSafeDictionaryBase &other)
	Copy constructor for safe collection. More...

PSafeDictionaryBase &	operator= (const PSafeDictionaryBase &other)
	Assign one safe collection to another. More...

virtual void	SetAt (const K &key, D *obj)
	Add an object to the collection. More...

virtual PBoolean	RemoveAt (const K &key)
	Remove an object to the collection. More...

virtual PBoolean	Contains (const K &key)
	Determine of the dictionary contains an entry for the key. More...

virtual PSafePtr< D >	GetAt (PINDEX idx, PSafetyMode mode=PSafeReadWrite)
	Get the instance in the collection of the index. More...

virtual PSafePtr< D >	Find (const K &key, PSafetyMode mode=PSafeReadWrite) const
	Find the instance in the collection of an object with the same value. More...

virtual PSafePtr< D >	FindIterator (const K &key, PSafetyMode mode=PSafeReadWrite) const
	Find instance and use PSafePtr as an iterator. More...

virtual P_DEPRECATED PSafePtr< D >	FindWithLock (const K &key, PSafetyMode mode=PSafeReadWrite) const

virtual bool	Move (const K &from, const K &to)
	Move an object from one key location to another. More...

void	MoveFrom (PSafeDictionaryBase &other)
	Move all objects from other dictionary to this one. More...

PArray< K >	GetKeys () const
	Get an array containing all the keys for the dictionary. More...

Public Member Functions inherited from PSafeCollection
	PSafeCollection (PCollection *collection)
	Create a thread safe collection of objects. More...

	~PSafeCollection ()
	Destroy the thread safe collection. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	RemoveAll (PBoolean synchronous=false)
	Remove all objects in collection. More...

void	AllowDeleteObjects (PBoolean yes=true)
	Disallow the automatic delete any objects that have been removed. More...

void	DisallowDeleteObjects ()
	Disallow the automatic delete any objects that have been removed. More...

virtual PBoolean	DeleteObjectsToBeRemoved ()
	Delete any objects that have been removed. More...

virtual void	DeleteObject (PObject *object) const
	Delete an objects that has been removed. More...

virtual void	SetAutoDeleteObjects ()
	Start a timer to automatically call DeleteObjectsToBeRemoved(). More...

PINDEX	GetSize () const
	Get the current size of the collection. More...

PBoolean	IsEmpty () const
	Determine if the collection is empty. More...

const PMutex &	GetMutex () const
	Get the mutex for the collection. More...

PMutex &	GetMutex ()

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	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Additional Inherited Members
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 PSafeCollection
void	CopySafeCollection (PCollection *other)

void	CopySafeDictionary (PAbstractDictionary *other)

bool	SafeAddObject (PSafeObject obj, PSafeObject old)

void	SafeRemoveObject (PSafeObject *obj)

virtual PBoolean	SafeRemove (PSafeObject *obj)
	Remove an object to the collection. More...

virtual PBoolean	SafeRemoveAt (PINDEX idx)
	Remove an object to the collection. 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 PSafeCollection
PCollection *	m_collection

PMutex	m_collectionMutex

bool	m_deleteObjects

PList< PSafeObject >	m_toBeRemoved

PMutex	m_removalMutex

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Detailed Description

template<class K, class D>
class PSafeDictionary< K, D >

This class defines a thread-safe array of objects.

See the PSafeObject class for more details. Especially in regard to enumeration of collections.

Member Typedef Documentation

template<class K , class D >

typedef D PSafeDictionary< K, D >::data_type

template<class K , class D >

typedef PSafeDictionary<K, D> PSafeDictionary< K, D >::dict_type

template<class K , class D >

typedef K PSafeDictionary< K, D >::key_type

template<class K , class D >

typedef PSafePtr<D> PSafeDictionary< K, D >::value_type

Member Function Documentation

template<class K , class D >

iterator PSafeDictionary< K, D >::begin ( )

inline

template<class K , class D >

const_iterator PSafeDictionary< K, D >::begin ( ) const

inline

template<class K , class D >

iterator PSafeDictionary< K, D >::end ( )

inline

template<class K , class D >

const_iterator PSafeDictionary< K, D >::end ( ) const

inline

template<class K , class D >

void PSafeDictionary< K, D >::erase ( const iterator & it )

inline

References PSafeDictionary< K, D >::iterator_pair::first, and PSafeDictionaryBase< PDictionary< K, D >, K, D >::RemoveAt().

template<class K , class D >

void PSafeDictionary< K, D >::erase ( const const_iterator & it )

inline

References PSafeDictionary< K, D >::iterator_pair::first, and PSafeDictionaryBase< PDictionary< K, D >, K, D >::RemoveAt().

template<class K , class D >

iterator PSafeDictionary< K, D >::find ( const K & key )

inline

template<class K , class D >

const_iterator PSafeDictionary< K, D >::find ( const K & key ) const

inline

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

safecoll.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class K, class D> class PSafeDictionary< K, D >

Member Typedef Documentation

Member Function Documentation

template<class K, class D>
class PSafeDictionary< K, D >