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

PSafePtrBase Class Reference

#include <safecoll.h>

Inheritance diagram for PSafePtrBase:

PObject PSafePtr< T > List of all members.

Construction

 ~PSafePtrBase ()
 PSafePtrBase (PSafeObject *obj=NULL, PSafetyMode mode=PSafeReference)
 PSafePtrBase (PSafeCollection &safeCollection, PSafetyMode mode, PINDEX idx)
 PSafePtrBase (PSafeCollection &safeCollection, PSafetyMode mode, PSafeObject *obj)
 PSafePtrBase (const PSafePtrBase &enumerator)

Operations

BOOL SetSafetyMode (PSafetyMode mode)
enum  EnterSafetyModeOption { WithReference, AlreadyReferenced }
enum  ExitSafetyModeOption { WithDereference, NoDereference }
void Assign (const PSafePtrBase &enumerator)
void Assign (PSafeCollection &safeCollection)
void Assign (PSafeObject *obj)
void Assign (PINDEX idx)
void Next ()
void Previous ()
BOOL EnterSafetyMode (EnterSafetyModeOption ref)
void ExitSafetyMode (ExitSafetyModeOption ref)

Public Member Functions

Overrides from class PObject
Comparison Compare (const PObject &obj) const

Protected Types


Protected Attributes

PSafeCollectioncollection
PSafeObjectcurrentObject
PSafetyMode lockMode

Detailed Description

This class defines a base class for thread-safe pointer to an object.

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.

NOTE: the PSafePtr will allow safe and mutexed access to objects but is not thread safe itself! You should not share PSafePtr instances across threads. You can assign a PSafePtr to another instance across a thread boundary provided it is on a reference and no read only or read/write locks are present.

See the PSafeObject class for more details.


Member Enumeration Documentation

enum PSafePtrBase::EnterSafetyModeOption [protected]
 

Enumeration values:
WithReference 
AlreadyReferenced 

enum PSafePtrBase::ExitSafetyModeOption [protected]
 

Enumeration values:
WithDereference 
NoDereference 


Constructor & Destructor Documentation

PSafePtrBase::PSafePtrBase PSafeObject obj = NULL,
PSafetyMode  mode = PSafeReference
[protected]
 

Create a new pointer to a PSafeObject. An optional locking mode may be provided to lock the object for reading or writing and automatically unlock it on destruction.

Note that this version is not associated with a collection so the ++ and -- operators will not work.

Parameters:
mode  Physical object to point to. Locking mode for the object

PSafePtrBase::PSafePtrBase PSafeCollection safeCollection,
PSafetyMode  mode,
PINDEX  idx
[protected]
 

Create a new pointer to a PSafeObject. An optional locking mode may be provided to lock the object for reading or writing and automatically unlock it on destruction.

The idx'th entry of the collection is pointed to by this object. If the idx is beyond the size of the collection, the pointer is NULL.

Parameters:
mode  Collection pointer will enumerate
idx  Locking mode for the object Index into collection to point to

PSafePtrBase::PSafePtrBase PSafeCollection safeCollection,
PSafetyMode  mode,
PSafeObject obj
[protected]
 

Create a new pointer to a PSafeObject. An optional locking mode may be provided to lock the object for reading or writing and automatically unlock it on destruction.

The obj parameter is only set if it contained in the collection, otherwise the pointer is NULL.

Parameters:
mode  Collection pointer will enumerate
obj  Locking mode for the object Inital object in collection to point to

PSafePtrBase::PSafePtrBase const PSafePtrBase enumerator  )  [protected]
 

Copy the pointer to the PSafeObject. This will create a copy of the pointer with the same locking mode and lock on the PSafeObject. It will also increment the reference count on the PSafeObject as well.

Parameters:
enumerator  Pointer to copy

PSafePtrBase::~PSafePtrBase  ) 
 

Unlock and dereference the PSafeObject this is pointing to.


Member Function Documentation

void PSafePtrBase::Assign PINDEX  idx  )  [protected]
 

void PSafePtrBase::Assign PSafeObject obj  )  [protected]
 

void PSafePtrBase::Assign PSafeCollection safeCollection  )  [protected]
 

void PSafePtrBase::Assign const PSafePtrBase enumerator  )  [protected]
 

Comparison PSafePtrBase::Compare const PObject obj  )  const [virtual]
 

Compare the pointers. Note this is not a value comparison and will only return EqualTo if the two PSafePtrBase instances are pointing to the same instance.

Parameters:
obj  Other instance to compare against

Reimplemented from PObject.

BOOL PSafePtrBase::EnterSafetyMode EnterSafetyModeOption  ref  )  [protected]
 

void PSafePtrBase::ExitSafetyMode ExitSafetyModeOption  ref  )  [protected]
 

void PSafePtrBase::Next  )  [protected]
 

void PSafePtrBase::Previous  )  [protected]
 

BOOL PSafePtrBase::SetSafetyMode PSafetyMode  mode  ) 
 

Change the locking mode used by this pointer.

Parameters:
mode  New locking mode


Member Data Documentation

PSafeCollection* PSafePtrBase::collection [protected]
 

PSafeObject* PSafePtrBase::currentObject [protected]
 

PSafetyMode PSafePtrBase::lockMode [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