Cpl::System::SharedEventHandlerApi Class Reference

This abstract class defines the interface for a Shared Event Handler. More...

Detailed Description

This abstract class defines the interface for a Shared Event Handler.

A Shared Event Handler is used to have function table instead of a hard coded switch() statement for handling/processing event flags notification.

#include <SharedEventHandler.h>

Inheritance diagram for Cpl::System::SharedEventHandlerApi:

Classes
struct	EventCallback_T
	Define a callback entry (i.e. More...

Public Types
typedef void(*	EventCallbackFunc_T) (void *context)
	Definition of event flag callback functions.

Public Member Functions
virtual void	processEventFlag (uint8_t eventNumber) noexcept=0
	This method 'dispatches' the processing associated with the specified Event based the list/array of callback functions.
virtual	~SharedEventHandlerApi ()
	Virtual destructor.

---

Class Documentation

Cpl::System::SharedEventHandlerApi::EventCallback_T

struct Cpl::System::SharedEventHandlerApi::EventCallback_T

Define a callback entry (i.e.

provide a 'context' pointer for the callback

Class Members
EventCallbackFunc_T	callbackFunc	Callback function pointer.
void *	context	Context for the callback. The callback function is required to 'understand' the actual type of the context pointer being passed to it.

Member Typedef Documentation

EventCallbackFunc_T

typedef void(* Cpl::System::SharedEventHandlerApi::EventCallbackFunc_T) (void *context)

Definition of event flag callback functions.

Constructor & Destructor Documentation

~SharedEventHandlerApi()

virtual Cpl::System::SharedEventHandlerApi::~SharedEventHandlerApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

processEventFlag()

virtual void Cpl::System::SharedEventHandlerApi::processEventFlag ( uint8_t  eventNumber )

pure virtualnoexcept

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

Implemented in Cpl::System::SharedEventHandler< N >.

---

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

• Cpl/System/SharedEventHandler.h