PTLib  Version 2.14.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T > Class Template Reference

Create a thread pooled timer execution with three parameters to work item. More...

#include <timer.h>

Inheritance diagram for PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >:
Collaboration diagram for PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >:

Public Member Functions

 PPoolTimerArg3 (Pool_T &pool, Arg1 arg1, Arg2 arg2, Arg3 arg3)
 
virtual Work_T * CreateWork ()
 
 PTIMER_OPERATORS (PPoolTimerArg3)
 
- Public Member Functions inherited from PPoolTimer< Base_T, Pool_T >
 PPoolTimer (Pool_T &pool)
 
virtual void OnTimeout ()
 This function is called on time out. More...
 
virtual const char * GetGroup (const Base_T &) const
 
 PTIMER_OPERATORS (PPoolTimer)
 
- Public Member Functions inherited from PTimer
 PTimer (long milliseconds=0, int seconds=0, int minutes=0, int hours=0, int days=0)
 Create a new timer object and start it in one shot mode for the specified amount of time. More...
 
 PTimer (const PTimeInterval &time)
 
 PTimer (const PTimer &timer)
 
PTimeroperator= (const PTimer &timer)
 Restart the timer in one shot mode using the specified time value. More...
 
 PTIMER_OPERATORS (PTimer)
 
virtual ~PTimer ()
 Destroy the timer object, stops timer if it is running. More...
 
virtual void PrintOn (ostream &strm) const
 Output the time interval to the I/O stream. More...
 
virtual void SetMilliSeconds (PInt64 msecs)
 Set the number of milliseconds for the time interval. More...
 
void RunContinuous (const PTimeInterval &time)
 Start a timer in continous cycle mode. More...
 
void Stop (bool wait=true)
 Stop a running timer. More...
 
PBoolean IsRunning () const
 Determine if the timer is currently running. More...
 
void Reset ()
 Restart a timer continuing from the time it was initially. More...
 
PTimeInterval GetResetTime () const
 Get the time this timer was set to initially. More...
 
const PNotifierGetNotifier () const
 Get the current call back function that is called whenever the timer expires. More...
 
void SetNotifier (const PNotifier &func)
 Set the call back function that is called whenever the timer expires. More...
 
PInt64 GetMilliSeconds () const
 Return number of milliseconds left in timer. More...
 
- Public Member Functions inherited from PTimeInterval
 PTimeInterval (PInt64 millisecs=0)
 Create a new time interval object. More...
 
 PTimeInterval (PInt64 millisecs, long seconds, long minutes=0, long hours=0, int days=0)
 
 PTimeInterval (const PString &str)
 
PObjectClone () const
 Create a new copy of the time interval. More...
 
virtual Comparison Compare (const PObject &obj) const
 Rank the two time intervals. More...
 
virtual void PrintOn (ostream &strm) const
 Output the time interval to the I/O stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the time interval from the I/O stream. More...
 
long GetSeconds () const
 Get the number of whole seconds for the time interval. More...
 
long GetMinutes () const
 Get the number of whole minutes for the time interval. More...
 
int GetHours () const
 Get the number of whole hours for the time interval. More...
 
int GetDays () const
 Get the number of whole days for the time interval. More...
 
DWORD GetInterval () const
 Get the number of milliseconds for the time interval. More...
 
virtual void SetInterval (PInt64 milliseconds=0, long seconds=0, long minutes=0, long hours=0, int days=0)
 Set the value of the time interval. More...
 
PTimeInterval operator- () const
 Unary minus, get negative of time interval. More...
 
PTimeInterval operator+ (const PTimeInterval &interval) const
 Add the two time intervals yielding a third time interval. More...
 
PTimeIntervaloperator+= (const PTimeInterval &interval)
 Add the second time interval to the first time interval. More...
 
PTimeInterval operator- (const PTimeInterval &interval) const
 Subtract the two time intervals yielding a third time interval. More...
 
PTimeIntervaloperator-= (const PTimeInterval &interval)
 Subtract the second time interval from the first time interval. More...
 
PTimeInterval operator* (int factor) const
 Multiply the time interval by a factor yielding a third time interval. More...
 
PTimeIntervaloperator*= (int factor)
 Multiply the time interval by a factor. More...
 
int operator/ (const PTimeInterval &smaller) const
 Divide the time interval by another interval yielding a count. More...
 
PTimeInterval operator/ (int factor) const
 Divide the time interval by a factor yielding a third time interval. More...
 
PTimeIntervaloperator/= (int factor)
 Divide the time interval by a factor. More...
 
bool operator== (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator== (long msecs) const
 
bool operator!= (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator!= (long msecs) const
 
bool operator> (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator> (long msecs) const
 
bool operator>= (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator>= (long msecs) const
 
bool operator< (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator< (long msecs) const
 
bool operator<= (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator<= (long msecs) const
 
PString AsString (int decimals=3, Formats format=NormalFormat, int width=1) const
 
- 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 ()
 
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 Attributes

Arg1 m_arg1
 
Arg2 m_arg2
 
Arg3 m_arg3
 
- Protected Attributes inherited from PPoolTimer< Base_T, Pool_T >
Pool_T & m_pool
 

Additional Inherited Members

- Public Types inherited from PTimeInterval
enum  Formats { NormalFormat, IncludeDays, SecondsOnly }
 
- 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 PTimer
static ListTimerList ()
 
static PTimeInterval Tick ()
 Get the number of milliseconds since some arbtrary point in time. More...
 
static unsigned Resolution ()
 Get the smallest number of milliseconds that the timer can be set to. More...
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 
- Friends inherited from PObject

Detailed Description

template<class Work_T, typename Arg1, typename Arg2, typename Arg3, class Base_T = Work_T, class Pool_T = PQueuedThreadPool<Base_T>>
class PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >

Create a thread pooled timer execution with three parameters to work item.

Constructor & Destructor Documentation

template<class Work_T , typename Arg1 , typename Arg2 , typename Arg3 , class Base_T = Work_T, class Pool_T = PQueuedThreadPool<Base_T>>
PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >::PPoolTimerArg3 ( Pool_T &  pool,
Arg1  arg1,
Arg2  arg2,
Arg3  arg3 
)
inline

Member Function Documentation

template<class Work_T , typename Arg1 , typename Arg2 , typename Arg3 , class Base_T = Work_T, class Pool_T = PQueuedThreadPool<Base_T>>
virtual Work_T* PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >::CreateWork ( )
inlinevirtual
template<class Work_T , typename Arg1 , typename Arg2 , typename Arg3 , class Base_T = Work_T, class Pool_T = PQueuedThreadPool<Base_T>>
PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >::PTIMER_OPERATORS ( PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >  )

Member Data Documentation

template<class Work_T , typename Arg1 , typename Arg2 , typename Arg3 , class Base_T = Work_T, class Pool_T = PQueuedThreadPool<Base_T>>
Arg1 PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >::m_arg1
protected
template<class Work_T , typename Arg1 , typename Arg2 , typename Arg3 , class Base_T = Work_T, class Pool_T = PQueuedThreadPool<Base_T>>
Arg2 PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >::m_arg2
protected
template<class Work_T , typename Arg1 , typename Arg2 , typename Arg3 , class Base_T = Work_T, class Pool_T = PQueuedThreadPool<Base_T>>
Arg3 PPoolTimerArg3< Work_T, Arg1, Arg2, Arg3, Base_T, Pool_T >::m_arg3
protected

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