This class extends the Cpl::System::EventLoop class to support the asynchronous change notification generated from Model Points. More...

Detailed Description

This class extends the Cpl::System::EventLoop class to support the asynchronous change notification generated from Model Points.

The order of processing is:

Event Flags are processed. Events are processed in LSb order.
The timers and their callbacks (if any timers have expired) are processed.
A single Model Point Change notification (if there is one pending) is processed.
The loop is repeated until there are no expired timers, no event flags, and no MP change notifications - at which point the thread blocks and wait for any of the above asynchronous actions to wake up the thread.

#include <EventLoop.h>

Inheritance diagram for Cpl::Dm::EventLoop:

[legend]

Collaboration diagram for Cpl::Dm::EventLoop:

[legend]

Public Member Functions
	EventLoop (unsigned long timingTickInMsec=OPTION_CPL_SYSTEM_EVENT_LOOP_TIMEOUT_PERIOD, Cpl::System::SharedEventHandlerApi *eventHandler=0) noexcept
	Constructor.

void	appRun ()
	See Cpl::System::Runnable.

void	addPendingChangingNotification_ (SubscriberApi &subscriber) noexcept
	This method has PACKAGE Scope, i.e.

void	removePendingChangingNotification_ (SubscriberApi &subscriber) noexcept
	This method has PACKAGE Scope, i.e.

Public Member Functions inherited from Cpl::System::EventLoop
	EventLoop (unsigned long timeOutPeriodInMsec=OPTION_CPL_SYSTEM_EVENT_LOOP_TIMEOUT_PERIOD, SharedEventHandlerApi *eventHandler=0)
	Constructor.

virtual	~EventLoop ()
	Virtual destructor.

int	signal (void) noexcept
	See Cpl::System::Signable.

int	su_signal (void) noexcept
	See Cpl::System::Signable.

void	pleaseStop ()
	See Cpl::System::Runnable.

void	notifyEvents (Cpl_System_EventFlag_T events) noexcept
	See Cpl::System::EventFlag.

void	notify (uint8_t eventNumber) noexcept
	See Cpl::System::EventFlag.

void	su_notifyEvents (Cpl_System_EventFlag_T events) noexcept
	See Cpl::System::EventFlag.

void	su_notify (uint8_t eventNumber) noexcept
	See Cpl::System::EventFlag.

void	setThreadOfExecution_ (Thread *myThreadPtr)
	See Cpl::System::Runnable.

Public Member Functions inherited from Cpl::System::Runnable
virtual	~Runnable ()
	Virtual destructor.

virtual void	run ()
	This method is called when the Thread is started.

virtual bool	isRunning () noexcept
	This method returns true if the instance has 'entered' its run method; false is returned, i.e.

Public Member Functions inherited from Cpl::System::EventFlag
virtual	~EventFlag ()
	Virtual destructor.

Public Member Functions inherited from Cpl::System::Signable
virtual	~Signable ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.

bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Public Member Functions inherited from Cpl::System::TimerManager
	TimerManager ()
	Constructor.

void	startManager (void) noexcept
	This method starts the Timer Manager.

void	processTimers (void) noexcept
	This method processes the current active timer lists.

bool	areActiveTimers (void) noexcept
	Returns true if there are NO active timers.

void	attach (CounterCallback_ &clientToCallback) noexcept
	See Cpl::System::CounterCallback_.

bool	detach (CounterCallback_ &clientToCallback) noexcept
	See Cpl::System::CounterCallback_.

unsigned long	msecToCounts (unsigned long milliseconds) noexcept
	See Cpl::System::CounterCallback_.

Public Member Functions inherited from Cpl::System::CounterSource_
virtual	~CounterSource_ ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Dm::NotificationApi_
virtual	~NotificationApi_ ()
	Virtual destructor.

Protected Member Functions
bool	isPendingPendingChangingNotifications () noexcept
	This method returns true if there is at least one pending change notification.

virtual void	processChangeNotifications () noexcept
	This helper method processes pending change notifications.

Protected Member Functions inherited from Cpl::System::EventLoop
virtual void	startEventLoop () noexcept
	This method is used to initialize the Event Loop's thread has started to executed.

virtual bool	waitAndProcessEvents (bool skipWait=false) noexcept
	This method is used to wait (and process) the next event(s).

virtual void	stopEventLoop () noexcept
	This method is used to clean-up the Event Loop's when the thread is being stopped.

virtual void	processEventFlag (uint8_t eventNumber) noexcept
	This method is used (by the concrete child class(es)) to process one or more Event Flags.

void	appRun ()
	See Cpl::System::Runnable.

Protected Member Functions inherited from Cpl::System::Runnable
	Runnable ()
	Constructor.

Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::System::TimerManager
void	addToActiveList (CounterCallback_ &clientToCallback) noexcept
	Helper method.

virtual void	tick (unsigned long milliseconds=1) noexcept
	This method is intended to be call by a the timing source and each call to this method represents that one tick has expired, i.e.

virtual void	tickComplete (void) noexcept
	This method is used by the Tick source to information the Timer Manager that there are no more ticks for the timing source's current tick cycle.

Protected Attributes
Cpl::Container::DList< SubscriberApi >	m_pendingMpNotifications
	List of pending Model Point Change Notifications.

Protected Attributes inherited from Cpl::System::EventLoop
Thread *	m_myThreadPtr
	A pointer to the thread the Event Loop executes in.

SharedEventHandlerApi *	m_eventHandler
	My shared event handler (if I have one)

Cpl::System::Semaphore	m_sema
	Semaphore associated with the mailbox (note: the Thread semaphore is NOT used)

unsigned long	m_timeout
	Timeout period for waiting on the next event.

unsigned long	m_timeStartOfLoop
	Timestamp, in milliseconds, of start of event/wait loop.

Cpl_System_EventFlag_T	m_events
	The variable holds the current state of all Event Flags.

bool	m_run
	Flag used to help with the pleaseStop() request.

Protected Attributes inherited from Cpl::System::Runnable
bool	m_running
	Tracks the run state of the instance.

Protected Attributes inherited from Cpl::System::TimerManager
Cpl::Container::DList< CounterCallback_ >	m_counters
	List of active counters.

Cpl::Container::DList< CounterCallback_ >	m_pendingAttach
	List of Pending-to-attach counters (this happens when timers attach from the timer-expired-callbacks)

unsigned long	m_timeMark
	Elapsed time of the previous processing cycle.

unsigned long	m_timeNow
	Elapsed time of the current processing cycle.

bool	m_inTickCall
	Flag to tracks when I am actively processing/consuming ticks.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Constructor & Destructor Documentation

◆ EventLoop()

Cpl::Dm::EventLoop::EventLoop	(	unsigned long	timingTickInMsec = `OPTION_CPL_SYSTEM_EVENT_LOOP_TIMEOUT_PERIOD`,
		Cpl::System::SharedEventHandlerApi *	eventHandler = `0`
	)

noexcept

Constructor.

The argument 'timingTickInMsec' specifies the timing resolution that will be used for Cpl::Timer::Local Timers.

NOTE: A value of zero for 'timingTickInMsec' will disable support for Local Timers.

Member Function Documentation

◆ addPendingChangingNotification_()

void Cpl::Dm::EventLoop::addPendingChangingNotification_ ( SubscriberApi & subscriber )

virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is used add a new 'change notification' to its list of pending change notifications. Calling this method when the subscriber is already registered for change notification will cause a FATAL ERROR.

This method IS thread safe.

NOTE: The requirements and/or semantics of Model Point subscription is that Subscriptions, Notifications, and Cancel-of-Subscriptions all happen in a SINGLE thread and that thread is the 'Subscribers' thread.

Implements Cpl::Dm::NotificationApi_.

◆ appRun()

void Cpl::Dm::EventLoop::appRun ( )

virtual

See Cpl::System::Runnable.

Implements Cpl::System::Runnable.

Reimplemented in Cpl::Dm::MailboxServer, and Cpl::Dm::PeriodicScheduler.

◆ isPendingPendingChangingNotifications()

bool Cpl::Dm::EventLoop::isPendingPendingChangingNotifications ( )

protectednoexcept

This method returns true if there is at least one pending change notification.

This method IS thread safe.

◆ processChangeNotifications()

virtual void Cpl::Dm::EventLoop::processChangeNotifications ( )

protectedvirtualnoexcept

This helper method processes pending change notifications.

◆ removePendingChangingNotification_()

void Cpl::Dm::EventLoop::removePendingChangingNotification_ ( SubscriberApi & subscriber )

virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is used remove a pending 'change notification' from its list of pending change notifications. It is okay to call this method even if the Subscriber is not current registered for change notifications.

This method IS thread safe.

NOTE: The requirements and/or semantics of Model Point subscription is that Subscriptions, Notifications, and Cancel-of-Subscriptions all happen in a SINGLE thread and that thread is the 'Subscribers' thread.

Implements Cpl::Dm::NotificationApi_.

Member Data Documentation

◆ m_pendingMpNotifications

Cpl::Container::DList<SubscriberApi> Cpl::Dm::EventLoop::m_pendingMpNotifications

protected

List of pending Model Point Change Notifications.

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

Cpl/Dm/EventLoop.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ EventLoop()

Member Function Documentation

◆ addPendingChangingNotification_()

◆ appRun()

◆ isPendingPendingChangingNotifications()

◆ processChangeNotifications()

◆ removePendingChangingNotification_()

Member Data Documentation

◆ m_pendingMpNotifications