Defines the interfaces for Timer Management Services.
More...
|
enum | wiced_timer_type_e { WICED_MILLI_SECONDS_TIMER,
WICED_SECONDS_TIMER,
WICED_MILLI_SECONDS_PERIODIC_TIMER,
WICED_SECONDS_PERIODIC_TIMER
} |
| Defines the wiced timer types. More...
|
|
Defines the interfaces for Timer Management Services.
#define wiced_timer_target_time_get |
( |
|
p_target_timer | ) |
(((p_target_timer))->tt) |
Get the expected trigger point (time) of target timer.
- Parameters
-
[in] | p_target_timer | : pointer to the target timer control block |
- Returns
- a 64-bit value time in microsecond.
Function prototype for the timer call back.
- Parameters
-
[in] | cb_params | :Timer callback function |
Timer structure.
NOTE: this structure is used internally by the wiced stack. Applications MUST NOT modify any of the elements of this structure.
Timer control block memory MUST be peristant from when the timer is initialized, using wiced_init_timer(), till it is de-initialized, using wiced_deinit_timer().
Defines the wiced timer types.
These timers are system tick driven and a systick is 1 millisecond.So the minimum timer resolution supported is 1 millisecond
Deinitialize a timer instance and stops the timer if it is running.
- Parameters
-
[in] | p_timer | :Pointer to the timer |
- Returns
- wiced_result_t
Initializes the timer.
- Parameters
-
[in] | p_timer | :Pointer to the timer structure |
[in] | p_timer_cb | :Timer callback function to be invoked on timer expiry |
[in] | cb_arg | :Parameter to be passed to the timer callback function which gets invoked on timer expiry,if any |
[in] | timer_type | :Shows if the timer is milliseconds or seconds, and if periodic or not |
- Returns
- wiced_result_t
Checks if a timer is in use.
- Parameters
-
[in] | p_timer | :Pointer to the timer structure |
- Returns
- 0 if the timer is not in use and non-zero value if the timer is in use
Starts a timer.
- Parameters
-
[in] | p_timer | :Pointer to the timer structure |
[in] | timeout_ms | :timeout in milliseconds |
- Returns
- wiced_result_t
Stops a timer.
- Parameters
-
[in] | p_timer | :Pointer to the timer structure |
- Returns
- wiced_result_t