Event bus

Details of the event bus mechanism and its functions. More...

Macros
#define	EVENT_GROUP(_event_type)   (event_group_t)((unsigned long)(_event_type) >> 8)
	Translate event type to event group.
#define	EVT_ATVV_STATE_DISABLED   1
#define	EVT_ATVV_STATE_ENABLED   0
#define	EVT_ATVV_STATE_MIC_CLOSE   3
#define	EVT_ATVV_STATE_MIC_OPEN   2
#define	EVT_ATVV_STATE_SEARCH_TIMEOUT   4

Typedefs
typedef bool(*	event_handler_t )(const event_t *p_event)
	Event handler. More...

Enumerations
enum	event_group_t {   EVT_GROUP_SYSTEM, EVT_GROUP_KEY, EVT_GROUP_REL, EVT_GROUP_HID,   EVT_GROUP_IR, EVT_GROUP_BT, EVT_GROUP_ATVV }
	Event groups. More...
enum	event_type_t
	Event types.

Functions
ret_code_t	event_bus_init (const event_handler_t *event_handlers_table)
	Function for initializing the event bus. More...
ret_code_t	event_send (event_type_t event_type,...)
	Function for sending an event. More...

Detailed Description

Details of the event bus mechanism and its functions.

Macro Definition Documentation

#define EVT_ATVV_STATE_DISABLED   1

ATVV state: disabled

#define EVT_ATVV_STATE_ENABLED   0

ATVV state: open

#define EVT_ATVV_STATE_MIC_CLOSE   3

ATVV state: microphone closed

#define EVT_ATVV_STATE_MIC_OPEN   2

ATVV state: microphone open

#define EVT_ATVV_STATE_SEARCH_TIMEOUT   4

ATVV state: search timeout

Typedef Documentation

typedef bool(* event_handler_t)(const event_t *p_event)

Event handler.

Parameters

[in]

p_event

Pointer to the event structure.

Returns

True if further processing of the given event should be abandoned.

Enumeration Type Documentation

enum event_group_t

Event groups.

Enumerator
EVT_GROUP_SYSTEM	System state events.
EVT_GROUP_KEY	Keyboard input events.
EVT_GROUP_REL	Relative motion events.
EVT_GROUP_HID	HID report events.
EVT_GROUP_IR	IR symbol events.
EVT_GROUP_BT	Bluetooth events.
EVT_GROUP_ATVV	ATVV events.

Function Documentation

ret_code_t event_bus_init

(

const event_handler_t *

event_handlers_table

)

Function for initializing the event bus.

Parameters

[in]

event_handlers_table

Table with event handlers.

Returns

NRF_SUCCESS on success, otherwise an error code.

ret_code_t event_send	(	event_type_t	event_type,
			...
	)

Function for sending an event.

Parameters

[in]	event_type	Event type.
[in]	...	Event data.

Note

Event data elements are mapped one to one to data fields in the event structure.

Returns

NRF_SUCCESS on success, otherwise an error code.