This mailbox class implements an Inter Thread Communications message queue. More...

Detailed Description

This mailbox class implements an Inter Thread Communications message queue.

There is no limit to the number of messages that can be stored in the queue at any given time since the FIFO queue and the messages uses the intrusive container mechanisms from the Cpl::Container namespace.

#include <Mailbox.h>

Inheritance diagram for Cpl::Itc::Mailbox:

[legend]

Collaboration diagram for Cpl::Itc::Mailbox:

[legend]

Public Member Functions
	Mailbox (Cpl::System::Signable &myEventLoop)
	Constructor.

void	post (Message &msg) noexcept
	See Cpl::Itc::PostApi.

void	postSync (Message &msg) noexcept
	See Cpl::Itc::PostApi.

Public Member Functions inherited from Cpl::Itc::PostApi
virtual	~PostApi ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Container::SList< Message >
	SList () noexcept
	Public constructor initializes head and tail pointers.

	SList (const char *ignoreThisParameter_usedToCreateAUniqueConstructor) noexcept
	This is a special constructor for when the list is statically declared (i.e.

void	move (SList< Message > &dst) noexcept
	Moves the content of the this queue to the specified queue.

void	clearTheList () noexcept
	Empties the list.

Message *	get (void) noexcept
	Removes the first item in the list.

void	put (Message &item) noexcept
	Adds the item as the last item in the list.

Message *	head (void) const noexcept
	Return a pointer to the first item in the list.

Message *	tail (void) const noexcept
	Return a pointer to the last item in the list.

Message *	pop (void) noexcept
	Removes the top element from stack and return a pointer to it as a result.

void	push (Message &item) noexcept
	Adds the ITEM item to top of the stack.

Message *	top (void) const noexcept
	Return a pointer to the top ITEM item in the stack.

Message *	getFirst (void) noexcept
	Removes the first item in the list.

Message *	getLast (void) noexcept
	Removes the last item in the list.

void	putFirst (Message &item) noexcept
	Adds the item as the first item in the list.

void	putLast (Message &item) noexcept
	Adds the item as the last item in the list.

bool	remove (Message &item) noexcept
	Remove specified ITEM element from the list.

void	insertAfter (Message &after, Message &item) noexcept
	Insert the "item" ITEM into the list behind the "after" ITEM element.

void	insertBefore (Message &before, Message &item) noexcept
	Insert the "item" ITEM into the list ahead of the "before" ITEM element.

bool	find (const Message &item) const noexcept
	Returns true if the specified item is already in the list, else false.

Message *	first (void) const noexcept
	Return a pointer to the first item in the list.

Message *	last (void) const noexcept
	Return a pointer to the last item in the list.

Message *	next (const Message &item) const noexcept
	Return a pointer to the item after the item "item".

Protected Member Functions
virtual void	processMessages () noexcept
	This operation is used process any pending messages.

bool	isPendingMessage () noexcept
	This method IS thread safe.

Protected Attributes
Cpl::System::Signable &	m_eventLoop
	The EventLoop that I wait-on/dispatch-msgs-from.

Constructor & Destructor Documentation

◆ Mailbox()

Cpl::Itc::Mailbox::Mailbox ( Cpl::System::Signable & myEventLoop )

Constructor.

Member Function Documentation

◆ isPendingMessage()

bool Cpl::Itc::Mailbox::isPendingMessage ( )

protectednoexcept

This method IS thread safe.

This method returns true if there is at least one queued ITC message

◆ post()

void Cpl::Itc::Mailbox::post ( Message & msg )

virtualnoexcept

See Cpl::Itc::PostApi.

Implements Cpl::Itc::PostApi.

◆ postSync()

void Cpl::Itc::Mailbox::postSync ( Message & msg )

virtualnoexcept

See Cpl::Itc::PostApi.

Implements Cpl::Itc::PostApi.

◆ processMessages()

virtual void Cpl::Itc::Mailbox::processMessages ( )

protectedvirtualnoexcept

This operation is used process any pending messages.

Member Data Documentation

◆ m_eventLoop

Cpl::System::Signable& Cpl::Itc::Mailbox::m_eventLoop

protected

The EventLoop that I wait-on/dispatch-msgs-from.

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

Cpl/Itc/Mailbox.h