If the RT and the server part are NOT in the same process, the POSIX message queue is used. The class provides the structure of the POSIX message queue and its corresponding functions. More...

#include <IpcMsgQueue.h>

Inheritance diagram for fesa::IpcMsgQueue:

Public Member Functions
	IpcMsgQueue (const std::string &name, std::size_t maxNMessages, std::size_t maxMessageSize, std::size_t nDiagMessages, bool blocking)
	Constructor. More...

	~IpcMsgQueue ()
	Destructor.

std::size_t	getNMessages () const
	Get the number of messages that are currently in the queue. More...

void	postMsg (const AbstractMessage *msg)
	Put a message into the queue. More...

const AbstractMessage *	consumeMsg ()
	Wait for the next message in the queue, retrieve the message and consume the message by resetting the message pointer. More...

void	purge ()
	Delete all the messages in the queue. More...

void	unlink ()
	Remove the message queue This member function should be called at process shutdown when the other process is not running.

Public Member Functions inherited from fesa::AbstractMsgQueue
virtual	~AbstractMsgQueue ()
	Destructor.

const std::string &	getName () const
	Get the queue's name. More...

std::size_t	getMaxNMessages () const
	Get the maximal number of messages the queue can contain. More...

virtual std::size_t	getMaxMessageSize () const
	Get the maximal size of a message in bytes. More...

bool	isFull () const
	Check if the queue is full. More...

bool	isAlmostFull () const
	Check if the queue is "almost" full (i.e. only diagnostics messages are allowed) More...

void	checkState (uint32_t msgPrio) const
	Check if the queue is full or "almost" full. More...

Additional Inherited Members
Protected Member Functions inherited from fesa::AbstractMsgQueue
	AbstractMsgQueue (const std::string &name, MessageQueueType::MessageQueueType type, std::size_t maxNMessages, std::size_t nDiagMessages)
	Constructor. More...

Detailed Description

If the RT and the server part are NOT in the same process, the POSIX message queue is used. The class provides the structure of the POSIX message queue and its corresponding functions.

Constructor & Destructor Documentation

fesa::IpcMsgQueue::IpcMsgQueue	(	const std::string &	name,
		std::size_t	maxNMessages,
		std::size_t	maxMessageSize,
		std::size_t	nDiagMessages,
		bool	blocking
	)

Constructor.

Parameters

name	The name of the message queue
maxNMessages	The maximum number of messages the queue can contain
maxMessageSize	The maximum size of each message in bytes
nDiagMessages	The number of messages that are reserved for diagnostics
blocking	The queue's read/write access mode