TIOVX User Guide
tivx_event_queue.h File Reference

Interface to Event Queue APIs. More...

Go to the source code of this file.

Data Structures

struct  tivx_event_queue_elem_t
 Element inserted into event queue. More...
 
struct  tivx_event_queue_t
 Event queue object. More...
 

Enumerations

enum  tivx_queue_type_e {
  TIVX_EVENT_GRAPH_QUEUE = VX_ATTRIBUTE_BASE(VX_ID_TI, (int32_t)0) + 0x1,
  TIVX_EVENT_CONTEXT_QUEUE = VX_ATTRIBUTE_BASE(VX_ID_TI, (int32_t)0) + 0x2
}
 Type of event that can be generated during system execution. More...
 

Functions

vx_status ownEventQueueCreate (tivx_event_queue_t *event_q)
 Create a event queue. More...
 
vx_status ownEventQueueDelete (tivx_event_queue_t *event_q)
 Delete a event queue. More...
 
vx_status ownEventQueueAddEvent (tivx_event_queue_t *event_q, vx_enum event_id, uint64_t timestamp, uint32_t app_value, uintptr_t param1, uintptr_t param2, uintptr_t param3)
 Add event to event queue. More...
 
void ownEventQueueEnableEvents (tivx_event_queue_t *event_q, vx_bool enable)
 Enable an event queue.
 
vx_status vxWaitEventQueue (tivx_event_queue_t *event_q, vx_event_t *event, vx_bool do_not_block)
 Generic wait event queue API.
 
vx_status ownRegisterEvent (vx_reference ref, enum tivx_queue_type_e queue_type, enum vx_event_type_e event_type, vx_uint32 param, vx_uint32 app_value)
 Registers an event to a given event queue.
 

Detailed Description

Interface to Event Queue APIs.

Event Queue can be used to collect framework generated events into a queue. When user calls vxWaitEvent the event is returned to the user in a first-in first out manner

Definition in file tivx_event_queue.h.

Enumeration Type Documentation

◆ tivx_queue_type_e

Type of event that can be generated during system execution.

Enumerator
TIVX_EVENT_GRAPH_QUEUE 

Graph event queue.

The registered event will be used in the graph event queue

TIVX_EVENT_CONTEXT_QUEUE 

Context event queue.

The registered event will be used in the context event queue

Definition at line 131 of file tivx_event_queue.h.

Function Documentation

◆ ownEventQueueCreate()

vx_status ownEventQueueCreate ( tivx_event_queue_t event_q)

Create a event queue.

Returns
event queue handle on success, else error

◆ ownEventQueueDelete()

vx_status ownEventQueueDelete ( tivx_event_queue_t event_q)

Delete a event queue.

Returns
event queue handle on success, else error

◆ ownEventQueueAddEvent()

vx_status ownEventQueueAddEvent ( tivx_event_queue_t event_q,
vx_enum  event_id,
uint64_t  timestamp,
uint32_t  app_value,
uintptr_t  param1,
uintptr_t  param2,
uintptr_t  param3 
)

Add event to event queue.

When events are disabled, event is not added to the event_q