PTLib  Version 2.18.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PSafeWork Class Referenceabstract

A PThreadPool work item template that uses PSafePtr to execute callback function. More...

#include <threadpool.h>

Inheritance diagram for PSafeWork:
Collaboration diagram for PSafeWork:

Public Member Functions

 PSafeWork (PSafeObject *ptr)
 
virtual void Work ()
 
virtual void CallFunction (PSafeObject &obj)=0
 
- Public Member Functions inherited from PSafePtrBase
virtual void Assign (const PSafePtrBase &ptr)
 
virtual void Assign (const PSafeCollection &safeCollection)
 
virtual void Assign (PSafeObject *obj)
 
virtual void Assign (PINDEX idx)
 
virtual Comparison Compare (const PObject &obj) const
 Compare the pointers. More...
 
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
virtual void SetNULL ()
 Set the pointer to NULL, unlocking/dereferencing existing pointer value. More...
 
bool operator! () const
 Return true if pointer is NULL. More...
 
PSafeObjectGetObject () const
 Return pointer to safe object. More...
 
template<class T >
T * GetObjectAs () const
 Return pointer to safe object. More...
 
PSafetyMode GetSafetyMode () const
 Get the locking mode used by this pointer. More...
 
virtual PBoolean SetSafetyMode (PSafetyMode mode)
 Change the locking mode used by this pointer. More...
 
 ~PSafePtrBase ()
 Unlock and dereference the PSafeObject this is pointing to. More...
 
- Public Member Functions inherited from PObject
__inline unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
__inline void SetTraceContextIdentifier (unsigned id)
 
__inline void SetTraceContextIdentifier (const PObject &obj)
 
__inline void SetTraceContextIdentifier (const PObject *obj)
 
__inline void CopyTraceContextIdentifier (PObject &obj) const
 
__inline void CopyTraceContextIdentifier (PObject *obj) const
 
virtual ~PObject ()
 
__inline const char * GetClass () const
 
__inline bool IsClass (const char *name) const
 
__inline const PObjectPTraceObjectInstance () const
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
template<class CLS >
CLS * CloneAs () const
 As for Clone() but converts to specified type. More...
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- Static Public Member Functions inherited from PObject
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject *from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject *from)
 
static __inline const char * Class ()
 
static __inline const PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (const PObject *obj)
 
template<typename T >
static Comparison Compare2 (T v1, T v2)
 Compare two types, returning Comparison type. More...
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
- Protected Types inherited from PSafePtrBase
enum  EnterSafetyModeOption { WithReference, AlreadyReferenced }
 
enum  ExitSafetyModeOption { WithDereference, NoDereference }
 
- Protected Member Functions inherited from PSafePtrBase
virtual void Next ()
 
virtual void Previous ()
 
virtual void DeleteObject (PSafeObject *obj)
 
PBoolean EnterSafetyMode (EnterSafetyModeOption ref)
 
void ExitSafetyMode (ExitSafetyModeOption ref)
 
virtual void LockPtr ()
 
virtual void UnlockPtr ()
 
 PSafePtrBase (PSafeObject *obj=NULL, PSafetyMode mode=PSafeReference)
 Create a new pointer to a PSafeObject. More...
 
 PSafePtrBase (const PSafeCollection &safeCollection, PSafetyMode mode, PINDEX idx)
 Create a new pointer to a PSafeObject. More...
 
 PSafePtrBase (const PSafeCollection &safeCollection, PSafetyMode mode, PSafeObject *obj)
 Create a new pointer to a PSafeObject. More...
 
 PSafePtrBase (const PSafePtrBase &enumerator)
 Copy the pointer to the PSafeObject. More...
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 
- Protected Attributes inherited from PSafePtrBase
const PSafeCollectionm_collection
 
PSafeObjectm_currentObject
 
PSafetyMode m_lockMode
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Detailed Description

A PThreadPool work item template that uses PSafePtr to execute callback function.

Constructor & Destructor Documentation

PSafeWork::PSafeWork ( PSafeObject ptr)
inline

Member Function Documentation

virtual void PSafeWork::Work ( )
inlinevirtual

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