Timer APIs. More...
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. More... | |
| typedef ClPtrT | ClTimerHandleT |
| The type of the handle identifying the timer. | |
Enumerations | |
| enum | ClTimerContextT { CL_TIMER_TASK_CONTEXT = 0 , CL_TIMER_SEPARATE_CONTEXT , CL_TIMER_MAX_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 , CL_TIMER_VOLATILE , CL_TIMER_MAX_TYPE } |
| type of action on timer expiry. More... | |
Functions | |
| ClRcT | clTimerConfigInitialize (void *pConfigData) |
| Configures the Timer library. More... | |
| ClRcT | clTimerCreate (ClTimerTimeOutT timeOut, ClTimerTypeT type, ClTimerContextT timerTaskSpawn, ClTimerCallBackT fpAction, void *pActionArgument, ClTimerHandleT *pTimerHandle) |
| Creates a timer. More... | |
| ClRcT | clTimerCreateAndStart (ClTimerTimeOutT timeOut, ClTimerTypeT type, ClTimerContextT timerTaskSpawn, ClTimerCallBackT fpAction, void *pActionArgument, ClTimerHandleT *pTimerHandle) |
| Creates a new timer and activates it. More... | |
| ClRcT | clTimerDelete (ClTimerHandleT *pTimerHandle) |
| Deletes a timer. More... | |
| ClRcT | clTimerFinalize (void) |
| Cleans up the Timer library. More... | |
| ClRcT | clTimerInitialize (ClPtrT pConfig) |
| Initializes the Timer library. More... | |
| ClRcT | clTimerRestart (ClTimerHandleT timerHandle) |
| Restarts a timer. More... | |
| ClRcT | clTimerStart (ClTimerHandleT timerHandle) |
| Starts a timer. More... | |
| ClRcT | clTimerStop (ClTimerHandleT timerHandle) |
| \breif Stops a timer. More... | |
| ClRcT | clTimerTypeGet (ClTimerHandleT timerHandle, ClUint32T *pTimerType) |
| Returns the timer type. More... | |
| ClRcT | clTimerUpdate (ClTimerHandleT timerHandle, ClTimerTimeOutT newTimeout) |
| Updates a timer. More... | |
Timer APIs.