IPCAlarm Class Reference

Provides a means of periodic action execution. More...

#include <alarm.h>

List of all members.

Public Types

typedef bool(*) Callback (void *)
 Defines a type of the function which can be executed by the IPCAlarm.

Public Member Functions

 IPCAlarm (long seconds, long nano_seconds, IPCAlarm::Callback callback, void *param=0)
 IPCAlarm (double period, IPCAlarm::Callback callback, void *param=0)
 ~IPCAlarm ()
void suspend ()
void resume ()

Classes

class  Thread


Detailed Description

Provides a means of periodic action execution.

See also:


Constructor & Destructor Documentation

IPCAlarm::IPCAlarm ( long  seconds,
long  nano_seconds,
IPCAlarm::Callback  callback,
void *  param = 0 
) [inline]

Setup an action which will be executed periodically either until this object is destoryed or untill the callback function will return false.

Parameters:
seconds number of seconds between different subsequent action invocations
nano_seconds number of nanoseconds between different subsequent action invocations which is added to the number of seconds
callback callback function which must be of the IPCAlarm::Callback type
param parameter which will be passed to the callback at every invocation

IPCAlarm::IPCAlarm ( double  period,
IPCAlarm::Callback  callback,
void *  param = 0 
) [inline]

Setup an action which will be executed periodically either until this object is destoryed or untill the callback function will return false.

Parameters:
period number of seconds between different subsequent action invocations
callback callback function which must be of the IPCAlarm::Callback type
param parameter which will be passed to the callback at every invocation

IPCAlarm::~IPCAlarm (  )  [inline]

Destroyes the alarm and stops the action invocations.

Parameters:
 


Member Function Documentation

void IPCAlarm::resume (  )  [inline]

Resumes action invocations.

See also:
suspend()

void IPCAlarm::suspend (  )  [inline]

Suspends action invocations.

See also:
resume()


The documentation for this class was generated from the following file:
Generated on Tue Aug 8 17:08:21 2006 for IPC User API by  doxygen 1.4.7