PSafeCollection Class Reference

#include <safecoll.h>

Inheritance diagram for PSafeCollection:

List of all members.

Operations
virtual void	RemoveAll (PBoolean synchronous=PFalse)
void	AllowDeleteObjects (PBoolean yes=PTrue)
void	DisallowDeleteObjects ()
virtual PBoolean	DeleteObjectsToBeRemoved ()
virtual void	DeleteObject (PObject *object) const
virtual void	SetAutoDeleteObjects ()
PINDEX	GetSize () const
PBoolean	IsEmpty () const
const PMutex &	GetMutex () const
virtual PBoolean	SafeRemove (PSafeObject *obj)
virtual PBoolean	SafeRemoveAt (PINDEX idx)
Public Member Functions
Construction
	PSafeCollection (PCollection *collection)
	~PSafeCollection ()
Protected Member Functions
void	SafeRemoveObject (PSafeObject *obj)
	PDECLARE_NOTIFIER (PTimer, PSafeCollection, DeleteObjectsTimeout)
Protected Attributes
PCollection *	collection
PMutex	collectionMutex
PBoolean	deleteObjects
PList< PSafeObject >	toBeRemoved
PMutex	removalMutex
PTimer	deleteObjectsTimer
Friends
class	PSafePtrBase

---

Detailed Description

This class defines a thread-safe collection of objects. This class is a wrapper around a standard PCollection class which allows only safe, mutexed, access to the collection.

This is part of a set of classes to solve the general problem of a collection (eg a PList or PDictionary) of objects that needs to be a made thread safe. Any thread can add, read, write or remove an object with both the object and the database of objects itself kept thread safe.

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

---

Constructor & Destructor Documentation

PSafeCollection::PSafeCollection

(

PCollection *

collection

)

Create a thread safe collection of objects. Note the collection is automatically deleted on destruction.

Parameters:

collection

Actual collection of objects

PSafeCollection::~PSafeCollection

(

)

Destroy the thread safe collection. The will delete the collection object provided in the constructor.

---

Member Function Documentation

void PSafeCollection::AllowDeleteObjects

(

PBoolean

yes = PTrue

)

[inline]

Disallow the automatic delete any objects that have been removed. Objects are simply removed from the collection and not marked for deletion using PSafeObject::SafeRemove() and DeleteObject().

Parameters:

yes	New value for flag for deleting objects

virtual void PSafeCollection::DeleteObject

(

PObject *

object

)

const [virtual]

Delete an objects that has been removed.

virtual PBoolean PSafeCollection::DeleteObjectsToBeRemoved

(

)

[virtual]

Delete any objects that have been removed. Returns PTrue if all objects in the collection have been removed and their pending deletions carried out.

void PSafeCollection::DisallowDeleteObjects

(

)

[inline]

Disallow the automatic delete any objects that have been removed. Objects are simply removed from the collection and not marked for deletion using PSafeObject::SafeRemove() and DeleteObject().

const PMutex& PSafeCollection::GetMutex

(

)

const [inline]

Get the mutex for the collection.

PINDEX PSafeCollection::GetSize

(

)

const

Get the current size of the collection. Note that usefulness of this function is limited as it is merely an instantaneous snapshot of the state of the collection.

PBoolean PSafeCollection::IsEmpty

(

)

const [inline]

Determine if the collection is empty. Note that usefulness of this function is limited as it is merely an instantaneous snapshot of the state of the collection.

PSafeCollection::PDECLARE_NOTIFIER	(	PTimer	,
		PSafeCollection	,
		DeleteObjectsTimeout
	)			[protected]

virtual void PSafeCollection::RemoveAll

(

PBoolean

synchronous = PFalse

)

[virtual]

Remove all objects in collection.

Parameters:

synchronous

Wait till objects are deleted before returning

virtual PBoolean PSafeCollection::SafeRemove

(

PSafeObject *

obj

)

[protected, virtual]

Remove an object to the collection. This function removes the object from the collection itself, but does not actually delete the object. It simply moves the object to a list of objects to be garbage collected at a later time.

As for Append() full mutual exclusion locking on the collection itself is maintained.

Parameters:

obj	Object to remove from collection

virtual PBoolean PSafeCollection::SafeRemoveAt

(

PINDEX

idx

)

[protected, virtual]

Remove an object to the collection. This function removes the object from the collection itself, but does not actually delete the object. It simply moves the object to a list of objects to be garbage collected at a later time.

As for Append() full mutual exclusion locking on the collection itself is maintained.

Parameters:

idx	Object index to remove

void PSafeCollection::SafeRemoveObject

(

PSafeObject *

obj

)

[protected]

virtual void PSafeCollection::SetAutoDeleteObjects

(

)

[virtual]

Start a timer to automatically call DeleteObjectsToBeRemoved().

---

Friends And Related Function Documentation

friend class PSafePtrBase [friend]

---

Member Data Documentation

PCollection* PSafeCollection::collection [protected]

PMutex PSafeCollection::collectionMutex [mutable, protected]

PBoolean PSafeCollection::deleteObjects [protected]

PTimer PSafeCollection::deleteObjectsTimer [protected]

PMutex PSafeCollection::removalMutex [protected]

PList<PSafeObject> PSafeCollection::toBeRemoved [protected]

---

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

• safecoll.h

---