teste de publish

Dependencies:   DS1820 HighSpeedAnalogIn devices mbed

Embed: (wiki syntax)

« Back to documentation index

RtosTimer Class Reference

RtosTimer Class Reference

The RtosTimer class allow creating and and controlling of timer functions in the system. More...

#include <RtosTimer.h>

Public Member Functions

 RtosTimer (void(*task)(void const *argument), os_timer_type type=osTimerPeriodic, void *argument=NULL)
 Create and Start timer.
osStatus stop (void)
 Stop the timer.
osStatus start (uint32_t millisec)
 start a timer.

Detailed Description

The RtosTimer class allow creating and and controlling of timer functions in the system.

A timer function is called when a time period expires whereby both on-shot and periodic timers are possible. A timer can be started, restarted, or stopped.

Timers are handled in the thread osTimerThread. Callback functions run under control of this thread and may use CMSIS-RTOS API calls.

Definition at line 37 of file RtosTimer.h.


Constructor & Destructor Documentation

RtosTimer ( void(*)(void const *argument)  task,
os_timer_type  type = osTimerPeriodic,
void *  argument = NULL 
)

Create and Start timer.

Parameters:
taskname of the timer call back function.
typeosTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
argumentargument to the timer call back function. (default: NULL)

Definition at line 31 of file RtosTimer.cpp.


Member Function Documentation

osStatus start ( uint32_t  millisec )

start a timer.

Parameters:
millisectime delay value of the timer.
Returns:
status code that indicates the execution status of the function.

Definition at line 41 of file RtosTimer.cpp.

osStatus stop ( void   )

Stop the timer.

Returns:
status code that indicates the execution status of the function.

Definition at line 45 of file RtosTimer.cpp.