LedEventListener Class Reference

Observer interface for receiving LED completion and error events. More...

#include <LedEventListener.h>

Public Member Functions
virtual	~LedEventListener ()=default
virtual void	onLedComplete (uint16_t id, LedSide side)
	Called when an activity completes.
virtual void	onLedError (uint16_t id, LedSide side, LedErrorType type)
	Called when an activity fails or is aborted.

Detailed Description

Observer interface for receiving LED completion and error events.

Register an implementation using LedEvent::AddListener().

Warning

Do not destroy a listener object while it is registered.

Constructor & Destructor Documentation

~LedEventListener()

virtual LedEventListener::~LedEventListener ( )

virtualdefault

Member Function Documentation

onLedComplete()

virtual void LedEventListener::onLedComplete ( uint16_t id, LedSide side )

virtual

Called when an activity completes.

Parameters

id	Activity identifier passed to LedControl::processActivity().
side	LED side associated with the completion.

onLedError()

virtual void LedEventListener::onLedError ( uint16_t id, LedSide side, LedErrorType type )

virtual

Called when an activity fails or is aborted.

Parameters

id	Activity identifier passed to LedControl::processActivity().
side	LED side associated with the error.
type	Error type.

---

The documentation for this class was generated from the following file:

• modules/headers/LedEventListener.h