clTimerApi.h File Reference

Timer APIs. More...

#include <clCommon.h>
#include <clBufferApi.h>

Go to the source code of this file.

Classes
struct	ClTimerConfigT
	It contains the timer library configuration information. More...
struct	ClTimerTimeOutT
	The timeout value in seconds and milliseconds. More...

Typedefs
typedef ClRcT(*	ClTimerCallBackT )(void *)
	The type fo the callback fucntion that will be called on timer expiry.
typedef ClPtrT	ClTimerHandleT
	The type of the handle identifying the timer.

Enumerations
enum	ClTimerContextT {   CL_TIMER_TASK_CONTEXT = 0,   CL_TIMER_SEPARATE_CONTEXT }
	When the timer expires, decides the method of invocation of the timer callback function. More...
enum	ClTimerTypeT {   CL_TIMER_ONE_SHOT = 0,   CL_TIMER_REPETITIVE }
	*type of action on timer expiry. More...

Functions
ClRcT	clTimerConfigInitialize (void *pConfigData)
	Configures the Timer library.
ClRcT	clTimerCreate (ClTimerTimeOutT timeOut, ClTimerTypeT type, ClTimerContextT timerTaskSpawn, ClTimerCallBackT fpAction, void *pActionArgument, ClTimerHandleT *pTimerHandle)
	Creates a timer.
ClRcT	clTimerCreateAndStart (ClTimerTimeOutT timeOut, ClTimerTypeT type, ClTimerContextT timerTaskSpawn, ClTimerCallBackT fpAction, void *pActionArgument, ClTimerHandleT *pTimerHandle)
	Creates a new timer and activates it.
ClRcT	clTimerDelete (ClTimerHandleT *pTimerHandle)
	Deletes a timer.
ClRcT	clTimerFinalize (void)
	Cleans up the Timer library.
ClRcT	clTimerInitialize (ClPtrT pConfig)
	Initializes the Timer library.
ClRcT	clTimerRestart (ClTimerHandleT timerHandle)
	Restarts a timer.
ClRcT	clTimerStart (ClTimerHandleT timerHandle)
	Starts a timer.
ClRcT	clTimerStop (ClTimerHandleT timerHandle)
	Stops a timer.
ClRcT	clTimerTypeGet (ClTimerHandleT timerHandle, ClUint32T *pTimerType)
	Returns the timer type.
ClRcT	clTimerUpdate (ClTimerHandleT timerHandle, ClTimerTimeOutT newTimeout)
	Updates a timer.

Detailed Description

Timer APIs.