Events

Functions
wiced_result_t	wiced_rtos_deregister_timed_event (wiced_timed_event_t *event_object)
wiced_result_t	wiced_rtos_register_timed_event (wiced_timed_event_t *event_object, wiced_worker_thread_t *worker_thread, event_handler_t function, uint32_t time_ms, void *arg)
wiced_result_t	wiced_rtos_send_asynchronous_event (wiced_worker_thread_t *worker_thread, event_handler_t function, void *arg)

Detailed Description

Event management functions

Function Documentation

wiced_rtos_deregister_timed_event()

wiced_result_t wiced_rtos_deregister_timed_event

(

wiced_timed_event_t *

event_object

)

Removes a request for function to be called at regular interval.

This function De-register's a function that has previously been set-up with wiced_rtos_register_timed_event.

Parameters

[in]

event_object

: The event handle used with wiced_rtos_register_timed_event

Returns

WICED_SUCCESS : on success.

WICED_ERROR : if an error occurred

wiced_rtos_register_timed_event()

wiced_result_t wiced_rtos_register_timed_event	(	wiced_timed_event_t *	event_object,
		wiced_worker_thread_t *	worker_thread,
		event_handler_t	function,
		uint32_t	time_ms,
		void *	arg )

Requests a function be called at a regular interval

This function registers a function that will be called at a regular interval. Since this is based on the RTOS time-slice scheduling, the accuracy is not high, and is affected by processor load.

Parameters

[in]	event_object	: Pointer to a event handle which will be initialized
[in]	worker_thread	: Pointer to the worker thread in whose context the callback function runs on
[in]	function	: The callback function that is to be called regularly
[in]	time_ms	: The time period between function calls in milliseconds
[in]	arg	: An argument that will be supplied to the function when it is called

Returns

WICED_SUCCESS : on success.

WICED_ERROR : if an error occurred

wiced_rtos_send_asynchronous_event()

wiced_result_t wiced_rtos_send_asynchronous_event	(	wiced_worker_thread_t *	worker_thread,
		event_handler_t	function,
		void *	arg )

Sends an asynchronous event to the associated worker thread

Parameters

[in]	worker_thread	: The worker thread in which context the callback should execute from
[in]	function	: The callback function to be called from the worker thread
[in]	arg	: The argument to be passed to the callback function

Returns

WICED_SUCCESS : on success.

WICED_ERROR : if an error occurred