#include <safecoll.h>
Inheritance diagram for PSafeCollection:
Operations | |
| virtual void | RemoveAll (BOOL synchronous=FALSE) |
| void | AllowDeleteObjects (BOOL yes=TRUE) |
| void | DisallowDeleteObjects () |
| virtual BOOL | DeleteObjectsToBeRemoved () |
| virtual void | DeleteObject (PObject *object) const |
| virtual void | SetAutoDeleteObjects () |
| PINDEX | GetSize () const |
| BOOL | IsEmpty () const |
| const PMutex & | GetMutex () const |
| virtual BOOL | SafeRemove (PSafeObject *obj) |
| virtual BOOL | SafeRemoveAt (PINDEX idx) |
Protected Member Functions | |
| void | SafeRemoveObject (PSafeObject *obj) |
| PDECLARE_NOTIFIER (PTimer, PSafeCollection, DeleteObjectsTimeout) | |
Protected Attributes | |
| PCollection * | collection |
| PMutex | collectionMutex |
| BOOL | deleteObjects |
| PList< PSafeObject > | toBeRemoved |
| PMutex | removalMutex |
| PTimer | deleteObjectsTimer |
Friends | |
| class | PSafePtrBase |
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.
| PSafeCollection::PSafeCollection | ( | PCollection * | collection | ) |
Create a thread safe collection of objects. Note the collection is automatically deleted on destruction.
| collection | Actual collection of objects |
| PSafeCollection::~PSafeCollection | ( | ) |
Destroy the thread safe collection. The will delete the collection object provided in the constructor.
| PSafeCollection::PSafeCollection | ( | PCollection * | collection | ) |
Create a thread safe collection of objects. Note the collection is automatically deleted on destruction.
| collection | Actual collection of objects |
| PSafeCollection::~PSafeCollection | ( | ) |
Destroy the thread safe collection. The will delete the collection object provided in the constructor.
| 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.
| 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.
| idx | Object index to remove |
| virtual void PSafeCollection::RemoveAll | ( | BOOL | synchronous = FALSE |
) | [virtual] |
Remove all objects in collection.
| synchronous | Wait till objects are deleted before returning |
| void PSafeCollection::AllowDeleteObjects | ( | BOOL | yes = TRUE |
) | [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().
| yes | New value for flag for deleting objects |
| 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().
| virtual BOOL PSafeCollection::DeleteObjectsToBeRemoved | ( | ) | [virtual] |
Delete any objects that have been removed. Returns TRUE if all objects in the collection have been removed and their pending deletions carried out.
| virtual void PSafeCollection::DeleteObject | ( | PObject * | object | ) | const [virtual] |
Delete an objects that has been removed.
| virtual void PSafeCollection::SetAutoDeleteObjects | ( | ) | [virtual] |
Start a timer to automatically call DeleteObjectsToBeRemoved().
| 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.
| BOOL 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.
| const PMutex& PSafeCollection::GetMutex | ( | ) | const [inline] |
Get the mutex for the collection.
| void PSafeCollection::SafeRemoveObject | ( | PSafeObject * | obj | ) | [protected] |
| PSafeCollection::PDECLARE_NOTIFIER | ( | PTimer | , | |
| PSafeCollection | , | |||
| DeleteObjectsTimeout | ||||
| ) | [protected] |
friend class PSafePtrBase [friend] |
PCollection* PSafeCollection::collection [protected] |
PMutex PSafeCollection::collectionMutex [mutable, protected] |
BOOL PSafeCollection::deleteObjects [protected] |
PList<PSafeObject> PSafeCollection::toBeRemoved [protected] |
PMutex PSafeCollection::removalMutex [protected] |
PTimer PSafeCollection::deleteObjectsTimer [protected] |
1.5.1