LedEvent Namespace Reference

Functions
void	AddListener (LedEventListener *observer, bool priority=false)
	Register a LedEventListener instance.
void	RemoveListener (LedEventListener *observer)
	Unregister a previously registered LedEventListener instance.
void	AddListenerOnComplete (void(*onEvent)(uint16_t id, LedSide side))
	Register a static/free function to receive completion events.
void	RemoveListenerOnComplete (void(*onEvent)(uint16_t id, LedSide side))
	Unregister a previously registered completion callback.
void	AddListenerOnError (void(*onError)(uint16_t id, LedSide side, LedErrorType type))
	Register a static/free function to receive error events.
void	RemoveListenerOnError (void(*onError)(uint16_t id, LedSide side, LedErrorType type))
	Unregister a previously registered error callback.

Function Documentation

AddListener()

void LedEvent::AddListener	(	LedEventListener *	observer,
		bool	priority = false )

Register a LedEventListener instance.

Parameters

observer	Listener object to register.
priority	If true, the listener is inserted with higher priority (called earlier).

Warning

Keep observer alive while it is registered. Unregister it before destruction.

AddListenerOnComplete()

void LedEvent::AddListenerOnComplete

(

void(*

onEvent )(uint16_t id, LedSide side)

)

Register a static/free function to receive completion events.

Parameters

onEvent

Callback invoked when an activity completes.

Examples

LedControl/main.cpp.

AddListenerOnError()

void LedEvent::AddListenerOnError

(

void(*

onError )(uint16_t id, LedSide side, LedErrorType type)

)

Register a static/free function to receive error events.

Parameters

onError

Callback invoked when an activity fails or is aborted.

Examples

LedControl/main.cpp.

RemoveListener()

void LedEvent::RemoveListener

(

LedEventListener *

observer

)

Unregister a previously registered LedEventListener instance.

Parameters

observer

Listener object to unregister.

RemoveListenerOnComplete()

void LedEvent::RemoveListenerOnComplete

(

void(*

onEvent )(uint16_t id, LedSide side)

)

Unregister a previously registered completion callback.

Parameters

onEvent

Callback to remove.

Examples

LedControl/main.cpp.

RemoveListenerOnError()

void LedEvent::RemoveListenerOnError

(

void(*

onError )(uint16_t id, LedSide side, LedErrorType type)

)

Unregister a previously registered error callback.

Parameters

onError

Callback to remove.

Examples

LedControl/main.cpp.