PWLib  1.10.10
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
PSafePtrBase Class Reference

#include <safecoll.h>

Inheritance diagram for PSafePtrBase:
PObject PSafePtr< T >

List of all members.

Public Member Functions

void Assign (const PSafePtrBase &ptr)
void Assign (const PSafeCollection &safeCollection)
void Assign (PSafeObject *obj)
void Assign (PINDEX idx)
Overrides from class PObject
Comparison Compare (const PObject &obj) const
Operations
bool operator! () const
PSafetyMode GetSafetyMode () const
BOOL SetSafetyMode (PSafetyMode mode)
const PSafeCollectionGetCollection () const

Protected Types

enum  EnterSafetyModeOption { WithReference, AlreadyReferenced }
enum  ExitSafetyModeOption { WithDereference, NoDereference }

Protected Member Functions

void Next ()
void Previous ()
BOOL EnterSafetyMode (EnterSafetyModeOption ref)
void ExitSafetyMode (ExitSafetyModeOption ref)

Protected Attributes

const PSafeCollectioncollection
PSafeObjectcurrentObject
PSafetyMode lockMode

Construction

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

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

Enumerator:
WithReference 
AlreadyReferenced 
Enumerator:
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:
objPhysical object to point to.
modeLocking mode for the object
PSafePtrBase::PSafePtrBase ( const 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:
safeCollectionCollection pointer will enumerate
modeLocking mode for the object
idxIndex into collection to point to
PSafePtrBase::PSafePtrBase ( const 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:
safeCollectionCollection pointer will enumerate
modeLocking mode for the object
objInital 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:
enumeratorPointer to copy

Unlock and dereference the PSafeObject this is pointing to.


Member Function Documentation

void PSafePtrBase::Assign ( const PSafePtrBase ptr)
void PSafePtrBase::Assign ( const PSafeCollection safeCollection)
void PSafePtrBase::Assign ( PINDEX  idx)
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:
objOther instance to compare against

Reimplemented from PObject.

const PSafeCollection* PSafePtrBase::GetCollection ( ) const [inline]

Get the associated collection this pointer may be contained in.

References collection.

Get the locking mode used by this pointer.

References lockMode.

void PSafePtrBase::Next ( ) [protected]
bool PSafePtrBase::operator! ( ) const [inline]

Return TRUE if pointer is NULL.

References currentObject.

void PSafePtrBase::Previous ( ) [protected]

Change the locking mode used by this pointer.

Parameters:
modeNew locking mode

Referenced by PSafeDictionaryBase< PDictionary< Key, Base >, Key, Base >::FindWithLock().


Member Data Documentation

Referenced by GetCollection().

Referenced by GetSafetyMode().


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