Cpl::System::SharedEventHandler< N > Class Template Reference

This template concrete class is a 'strategy class' in that in provides most of work needed for a Runnable object to support a list of callback functions for handling event-signally - instead of hard coded switch statement in its processEventFlag() method. More...

Detailed Description

template<int N>
class Cpl::System::SharedEventHandler< N >

This template concrete class is a 'strategy class' in that in provides most of work needed for a Runnable object to support a list of callback functions for handling event-signally - instead of hard coded switch statement in its processEventFlag() method.

Template Arg: N - the max number of callbacks supported.

#include <SharedEventHandler.h>

Inheritance diagram for Cpl::System::SharedEventHandler< N >:

Collaboration diagram for Cpl::System::SharedEventHandler< N >:

Public Member Functions
	SharedEventHandler (EventCallback_T(&myCallbacks)[N])
	Constructor.
void	processEventFlag (uint8_t eventNumber) noexcept
	This method 'dispatches' the processing associated with the specified Event based the list/array of callback functions.
Public Member Functions inherited from Cpl::System::SharedEventHandlerApi
virtual	~SharedEventHandlerApi ()
	Virtual destructor.

Protected Attributes
EventCallback_T(&	m_callbacks )[N]
	Reference to my callback functions.

Additional Inherited Members
Public Types inherited from Cpl::System::SharedEventHandlerApi
typedef void(*	EventCallbackFunc_T) (void *context)
	Definition of event flag callback functions.

Constructor & Destructor Documentation

SharedEventHandler()

template<int N>

Cpl::System::SharedEventHandler< N >::SharedEventHandler ( EventCallback_T(&)  myCallbacks[N] )

inline

Constructor.

The 'myCallbacks' argument is an an array of callback entries pointers. The order of array maps directly to the Event flag number, i.e. index 0 is the callback function for Event Flag 0. If no callback is supported for a particular Event Fla/Index use a zero (or nullptr) for the .callbackFunc field/value for the array entry.

Member Function Documentation

processEventFlag()

template<int N>

void Cpl::System::SharedEventHandler< N >::processEventFlag ( uint8_t  eventNumber )

inlinevirtualnoexcept

This method 'dispatches' the processing associated with the specified Event based the list/array of callback functions.

Implements Cpl::System::SharedEventHandlerApi.

Member Data Documentation

m_callbacks

template<int N>

EventCallback_T( & Cpl::System::SharedEventHandler< N >::m_callbacks)[N]

protected

Reference to my callback functions.

---

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

• Cpl/System/SharedEventHandler.h