Cpl::System::Signable Class Reference

This abstract class defines the interface by which a client can cause an object that is waiting-on-a-signal to become unblocked. More...

Detailed Description

This abstract class defines the interface by which a client can cause an object that is waiting-on-a-signal to become unblocked.

#include <Signable.h>

Inheritance diagram for Cpl::System::Signable:

Collaboration diagram for Cpl::System::Signable:

Public Member Functions
virtual	~Signable ()
	Virtual destructor.
virtual int	signal (void) noexcept=0
	This method is called by client to cause the server to become unblock and ready to run.
virtual int	su_signal (void) noexcept=0
	Same as signal(), EXCEPT this method can ONLY be called from supervisor mode and/or ISR contexts.
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.

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.
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.

Constructor & Destructor Documentation

~Signable()

virtual Cpl::System::Signable::~Signable ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

signal()

virtual int Cpl::System::Signable::signal ( void )

pure virtualnoexcept

This method is called by client to cause the server to become unblock and ready to run.

This method can ONLY be called from a thread context. The method returns zero on success.

Implemented in Cpl::System::BareMetal::Thread, Cpl::System::Cpp11::Thread, Cpl::System::EventLoop, Cpl::System::FreeRTOS::Thread, Cpl::System::Posix::Thread, Cpl::System::Semaphore, and Cpl::System::Win32::Thread.

su_signal()

virtual int Cpl::System::Signable::su_signal ( void )

pure virtualnoexcept

Same as signal(), EXCEPT this method can ONLY be called from supervisor mode and/or ISR contexts.

The method returns zero on success.

Implemented in Cpl::System::BareMetal::Thread, Cpl::System::Cpp11::Thread, Cpl::System::EventLoop, Cpl::System::FreeRTOS::Thread, Cpl::System::Posix::Thread, Cpl::System::Semaphore, and Cpl::System::Win32::Thread.

---

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

• Cpl/System/Signable.h