Cpl::System::EventFlag Class Reference

This abstract class defines the interface to generated a 'Event Flag'. More...

Detailed Description

This abstract class defines the interface to generated a 'Event Flag'.

Event Flags are used to indicate that an 'event' has occurred. Each Event Flag is represent by a bit the Cpl_System_Event_Flags_T data type.

Individual event flags can be viewed as binary semaphores with respect to be signaled/waiting (though waiting is done on the thread's entire set of event flags).

A thread (runnable object) can wait for at least one event to be signaled. When the thread is waiting on event(s) and it is then signaled - all of Events that were in the signaled state when the thread was unblock are cleared.

#include <EventFlag.h>

Inheritance diagram for Cpl::System::EventFlag:

Public Member Functions
virtual void	notifyEvents (Cpl_System_EventFlag_T events) noexcept=0
	This operation is called by clients to set one or more Event Flags.
virtual void	notify (uint8_t eventNumber) noexcept=0
	This operation is similar to notifyEvents(), except that it sets one event flags.
virtual void	su_notifyEvents (Cpl_System_EventFlag_T events) noexcept=0
	This method is same as notifyEvents() EXCEPT this method can ONLY be called from supervisor mode and/or ISR contexts.
virtual void	su_notify (uint8_t eventNumber) noexcept=0
	This method is same as notify() EXCEPT this method can ONLY be called from supervisor mode and/or ISR contexts.
virtual	~EventFlag ()
	Virtual destructor.

Constructor & Destructor Documentation

~EventFlag()

virtual Cpl::System::EventFlag::~EventFlag ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

notify()

virtual void Cpl::System::EventFlag::notify ( uint8_t  eventNumber )

pure virtualnoexcept

This operation is similar to notifyEvents(), except that it sets one event flags.

The 'eventNumber' is the bit number (zero based) of the Event Flag to set.

This method can ONLY be called from a thread context.

Implemented in Cpl::System::EventLoop.

notifyEvents()

virtual void Cpl::System::EventFlag::notifyEvents ( Cpl_System_EventFlag_T  events )

pure virtualnoexcept

This operation is called by clients to set one or more Event Flags.

Each bit in 'events' is different Event Flag.

This method can ONLY be called from a thread context.

Implemented in Cpl::System::EventLoop.

su_notify()

virtual void Cpl::System::EventFlag::su_notify ( uint8_t  eventNumber )

pure virtualnoexcept

This method is same as notify() EXCEPT this method can ONLY be called from supervisor mode and/or ISR contexts.

Implemented in Cpl::System::EventLoop.

su_notifyEvents()

virtual void Cpl::System::EventFlag::su_notifyEvents ( Cpl_System_EventFlag_T  events )

pure virtualnoexcept

This method is same as notifyEvents() EXCEPT this method can ONLY be called from supervisor mode and/or ISR contexts.

Implemented in Cpl::System::EventLoop.

---

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

• Cpl/System/EventFlag.h