Event APIs

Detailed Description

APIs for event operations on the host.

Defines
#define	TIVX_EVENT_TIMEOUT_NO_WAIT   (0u)
	Constant to indicate tivxEventPend() should only check and not wait for event to arrive.
#define	TIVX_EVENT_TIMEOUT_WAIT_FOREVER   (0xFFFFFFFFu)
	Constant to indicate tivxEventPend() should only wait forever for the event to arrive.

Typedefs
typedef struct _tivx_event_t *	tivx_event
	Typedef for a event.

Functions
vx_status	tivxEventCreate (tivx_event *event)
	Create a event. More...
vx_status	tivxEventDelete (tivx_event *event)
	Delete a event. More...
vx_status	tivxEventPost (tivx_event event)
	Post a event. More...
vx_status	tivxEventWait (tivx_event event, uint32_t timeout)
	Pend on a event. More...
vx_status	tivxEventClear (tivx_event event)
	Clear any pending events. More...

Function Documentation

tivxEventCreate()

vx_status tivxEventCreate

(

tivx_event *

event

)

Create a event.

Parameters

event

[out] Pointer to event object

Returns

VX_SUCCESS on success

tivxEventDelete()

vx_status tivxEventDelete

(

tivx_event *

event

)

Delete a event.

Parameters

event

[in] Pointer to event object

Returns

VX_SUCCESS on success

tivxEventPost()

vx_status tivxEventPost

(

tivx_event

event

)

Post a event.

Parameters

event

[in] event object

Returns

VX_SUCCESS on success

tivxEventWait()

vx_status tivxEventWait	(	tivx_event	event,
		uint32_t	timeout
	)

Pend on a event.

Parameters

event	[in] event object
timeout	[in] Timeout in units of msecs, use TIVX_EVENT_TIMEOUT_WAIT_FOREVER to wait forever

Returns

VX_SUCCESS on success

tivxEventClear()

vx_status tivxEventClear

(

tivx_event

event

)

Clear any pending events.

Parameters

event

[in] event object

Returns

VX_SUCCESS on success