|
Xenomai API
2.6.3
|
|
Typedefs | |
| typedef void(* | rtdm_timer_handler_t )(rtdm_timer_t *timer) |
| Timer handler. | |
Functions | |
| int | rtdm_timer_init (rtdm_timer_t *timer, rtdm_timer_handler_t handler, const char *name) |
| Initialise a timer. | |
| void | rtdm_timer_destroy (rtdm_timer_t *timer) |
| Destroy a timer. | |
| int | rtdm_timer_start (rtdm_timer_t *timer, nanosecs_abs_t expiry, nanosecs_rel_t interval, enum rtdm_timer_mode mode) |
| Start a timer. | |
| void | rtdm_timer_stop (rtdm_timer_t *timer) |
| Stop a timer. | |
| int | rtdm_timer_start_in_handler (rtdm_timer_t *timer, nanosecs_abs_t expiry, nanosecs_rel_t interval, enum rtdm_timer_mode mode) |
| Start a timer from inside a timer handler. | |
| void | rtdm_timer_stop_in_handler (rtdm_timer_t *timer) |
| Stop a timer from inside a timer handler. | |
RTDM_TIMERMODE_xxx | |
| enum | rtdm_timer_mode { RTDM_TIMERMODE_RELATIVE = XN_RELATIVE, RTDM_TIMERMODE_ABSOLUTE = XN_ABSOLUTE, RTDM_TIMERMODE_REALTIME = XN_REALTIME } |
| typedef void(* rtdm_timer_handler_t)(rtdm_timer_t *timer) |
Timer handler.
| [in] | timer | Timer handle as returned by rtdm_timer_init() |
| enum rtdm_timer_mode |
| void rtdm_timer_destroy | ( | rtdm_timer_t * | timer | ) |
Destroy a timer.
| [in,out] | timer | Timer handle as returned by rtdm_timer_init() |
Environments:
This service can be called from:
Rescheduling: never.
References xntimer_destroy().
| int rtdm_timer_init | ( | rtdm_timer_t * | timer, |
| rtdm_timer_handler_t | handler, | ||
| const char * | name | ||
| ) |
Initialise a timer.
| [in,out] | timer | Timer handle |
| [in] | handler | Handler to be called on timer expiry |
| [in] | name | Optional timer name |
Environments:
This service can be called from:
Rescheduling: never.
| int rtdm_timer_start | ( | rtdm_timer_t * | timer, |
| nanosecs_abs_t | expiry, | ||
| nanosecs_rel_t | interval, | ||
| enum rtdm_timer_mode | mode | ||
| ) |
Start a timer.
| [in,out] | timer | Timer handle as returned by rtdm_timer_init() |
| [in] | expiry | Firing time of the timer, mode defines if relative or absolute |
| [in] | interval | Relative reload value, > 0 if the timer shall work in periodic mode with the specific interval, 0 for one-shot timers |
| [in] | mode | Defines the operation mode, see RTDM_TIMERMODE_xxx for possible values |
expiry describes an absolute date in the past.Environments:
This service can be called from:
Rescheduling: never.
References xntimer_start().
| int rtdm_timer_start_in_handler | ( | rtdm_timer_t * | timer, |
| nanosecs_abs_t | expiry, | ||
| nanosecs_rel_t | interval, | ||
| enum rtdm_timer_mode | mode | ||
| ) |
Start a timer from inside a timer handler.
| [in,out] | timer | Timer handle as returned by rtdm_timer_init() |
| [in] | expiry | Firing time of the timer, mode defines if relative or absolute |
| [in] | interval | Relative reload value, > 0 if the timer shall work in periodic mode with the specific interval, 0 for one-shot timers |
| [in] | mode | Defines the operation mode, see RTDM_TIMERMODE_xxx for possible values |
expiry describes an absolute date in the past.Environments:
This service can be called from:
Rescheduling: never.
| void rtdm_timer_stop | ( | rtdm_timer_t * | timer | ) |
Stop a timer.
| [in,out] | timer | Timer handle as returned by rtdm_timer_init() |
Environments:
This service can be called from:
Rescheduling: never.
References xntimer_stop().
| void rtdm_timer_stop_in_handler | ( | rtdm_timer_t * | timer | ) |
Stop a timer from inside a timer handler.
| [in,out] | timer | Timer handle as returned by rtdm_timer_init() |
Environments:
This service can be called from:
Rescheduling: never.