Event groups API

void	tiny_events_create (tiny_events_t *events)
	Creates cross platform event group object. More...
void	tiny_events_destroy (tiny_events_t *events)
	Destroys cross platform event group object. More...
uint8_t	tiny_events_wait (tiny_events_t *event, uint8_t bits, uint8_t clear, uint32_t timeout)
	Waits until any of specified bits is set or timeout. More...
uint8_t	tiny_events_check_int (tiny_events_t *event, uint8_t bits, uint8_t clear)
	Checks specified bits. More...
void	tiny_events_set (tiny_events_t *event, uint8_t bits)
	Sets bits for cross-platform event group object. More...
void	tiny_events_clear (tiny_events_t *event, uint8_t bits)
	Clears bits for cross-platform event group object. More...

Detailed Description

Cross-platform event group primitives for inter-thread signaling.

Function Documentation

tiny_events_check_int()

uint8_t tiny_events_check_int	(	tiny_events_t *	event,
		uint8_t	bits,
		uint8_t	clear
	)

Checks specified bits.

This API can be used in interrupt handlers

Parameters

event	pointer to tiny_event_t variable.
bits	bits to wait for
clear	flags EVENT_BITS_CLEAR or EVENT_BITS_LEAVE

Returns

0 if no any of requested bits are set list of bits from the input argument, which were set

tiny_events_clear()

void tiny_events_clear	(	tiny_events_t *	event,
		uint8_t	bits
	)

Clears bits for cross-platform event group object.

Parameters

event	pointer to tiny_event_t variable.
bits	bits to clear

tiny_events_create()

void tiny_events_create

(

tiny_events_t *

events

)

Creates cross platform event group object.

Parameters

events

pointer to tiny_event_t variable.

tiny_events_destroy()

void tiny_events_destroy

(

tiny_events_t *

events

)

Destroys cross platform event group object.

Parameters

events

pointer to tiny_event_t variable.

tiny_events_set()

void tiny_events_set	(	tiny_events_t *	event,
		uint8_t	bits
	)

Sets bits for cross-platform event group object.

Parameters

event	pointer to tiny_event_t variable.
bits	bits to set

tiny_events_wait()

uint8_t tiny_events_wait	(	tiny_events_t *	event,
		uint8_t	bits,
		uint8_t	clear,
		uint32_t	timeout
	)

Waits until any of specified bits is set or timeout.

Parameters

event	pointer to tiny_event_t variable.
bits	bits to wait for
clear	flags EVENT_BITS_CLEAR or EVENT_BITS_LEAVE
timeout	timeout in milliseconds to wait

Returns

0 on timeout list of bits from the input argument, which were set