PTLib  Version 2.14.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PSafeWorkNoArg< PtrClass, FuncRet > Class Template Reference

A PSafeWork thread pool item where call back has no arguments. More...

#include <threadpool.h>

Inheritance diagram for PSafeWorkNoArg< PtrClass, FuncRet >:
Collaboration diagram for PSafeWorkNoArg< PtrClass, FuncRet >:

Public Types

typedef FuncRet(PtrClass::* Function )()
 

Public Member Functions

 PSafeWorkNoArg (PtrClass *ptr, Function function)
 
virtual void CallFunction (PSafeObject &obj)
 
- Public Member Functions inherited from PSafeWork
 PSafeWork (PSafeObject *ptr)
 
virtual void Work ()
 
- 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
unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
void SetTraceContextIdentifier (unsigned id)
 
void GetTraceContextIdentifier (PObject &obj)
 
void GetTraceContextIdentifier (PObject *obj)
 
void SetTraceContextIdentifier (const PObject &obj)
 
void SetTraceContextIdentifier (const PObject *obj)
 
virtual ~PObject ()
 
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 const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. More...
 
__inline const PObjectPTraceObjectInstance () const
 
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...
 

Protected Member Functions

 P_ALIGN_FIELD (Function, m_function, 16)
 

Additional Inherited Members

- Static Public Member Functions inherited from PObject
static const char * Class ()
 Get the name of the class as a C string. More...
 
static __inline const PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (const PObject *obj)
 
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 Attributes inherited from PSafePtrBase
const PSafeCollectioncollection
 
PSafeObjectcurrentObject
 
PSafetyMode lockMode
 
- Friends inherited from PObject

Detailed Description

template<class PtrClass, typename FuncRet = void>
class PSafeWorkNoArg< PtrClass, FuncRet >

A PSafeWork thread pool item where call back has no arguments.

Member Typedef Documentation

template<class PtrClass , typename FuncRet = void>
typedef FuncRet(PtrClass::* PSafeWorkNoArg< PtrClass, FuncRet >::Function)()

Constructor & Destructor Documentation

template<class PtrClass , typename FuncRet = void>
PSafeWorkNoArg< PtrClass, FuncRet >::PSafeWorkNoArg ( PtrClass *  ptr,
Function  function 
)
inline

Member Function Documentation

template<class PtrClass , typename FuncRet = void>
virtual void PSafeWorkNoArg< PtrClass, FuncRet >::CallFunction ( PSafeObject obj)
inlinevirtual

Implements PSafeWork.

template<class PtrClass , typename FuncRet = void>
PSafeWorkNoArg< PtrClass, FuncRet >::P_ALIGN_FIELD ( Function  ,
m_function  ,
16   
)
protected

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