Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

PSafeCollection Class Reference

#include <safecoll.h>

Inheritance diagram for PSafeCollection:

PObject PSafeColl< Coll, Base > PSafeColl< PArray< Base >, Base > PSafeColl< PList< Base >, Base > PSafeColl< PSortedList< Base >, Base > PSafeDictionaryBase< Coll, Key, Base > PSafeDictionaryBase< PDictionary< Key, Base >, Key, Base > PSafeArray< Base > PSafeList< Base > PSafeSortedList< Base > PSafeDictionary< Key, Base > List of all members.

Operations

virtual void RemoveAll ()
virtual void DeleteObjectsToBeRemoved ()
virtual void SetAutoDeleteObjects ()
PINDEX GetSize () const
const PMutexGetMutex () const
virtual BOOL SafeRemove (PSafeObject *obj)
virtual BOOL 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

PCollectioncollection
PMutex collectionMutex
PAbstractList toBeRemoved
PMutex removalMutex
PTimer deleteObjectsTimer

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

virtual void PSafeCollection::DeleteObjectsToBeRemoved  )  [virtual]
 

Delete any objects that have been removed.

const PMutex& PSafeCollection::GetMutex  )  const [inline]
 

Get the mutex for the collection.

PINDEX PSafeCollection::GetSize  )  const [inline]
 

Get the current size of the collection. Note that use of this function is limited as it is not subject to the collections mutual exclusion locking. Thus, it is merely an instantaneous snapshot of the state of the collection.

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

virtual void PSafeCollection::RemoveAll  )  [virtual]
 

Remove all objects in collection.

virtual BOOL 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 BOOL 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().


Member Data Documentation

PCollection* PSafeCollection::collection [protected]
 

PMutex PSafeCollection::collectionMutex [protected]
 

PTimer PSafeCollection::deleteObjectsTimer [protected]
 

PMutex PSafeCollection::removalMutex [protected]
 

PAbstractList PSafeCollection::toBeRemoved [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Jul 24 15:35:59 2004 for PWLib by doxygen 1.3.7