MAKVrExchange::DtMessageQueue Class Reference

This is an abstract base class presenting an interface for a simple message queue. More...

Inheritance diagram for MAKVrExchange::DtMessageQueue:

Public Member Functions
	DtMessageQueue ()
	CTOR.
virtual	~DtMessageQueue ()
	Virtual DTOR.
virtual bool	isEmpty ()=0
	returns true if there are no messages to be read.
virtual void	sendMessage (const void *message, unsigned int messageSize, bool global=false)=0
	Inserts message of size messageSize into queue.
virtual void *	message (unsigned int *outSize=0)=0
	Returns a pointer to the oldest message in the queue, returns 0 if there are no messages waiting in the queue.
virtual std::ostream &	printDataToStream (std::ostream &str) const =0
	Prints the internal state of the queue to a stream.

Private Member Functions
	DtMessageQueue (const DtMessageQueue &other)
	Copy Ctor Not Implemented – Class Not Copiable.
DtMessageQueue &	operator= (const DtMessageQueue &other)
	Assignment Operator Not Implemented – Class Not Copiable.

Detailed Description

This is an abstract base class presenting an interface for a simple message queue.

Messages of arbitrary size can be sent, and read with FIFO.

Constructor & Destructor Documentation

MAKVrExchange::DtMessageQueue::DtMessageQueue

(

)

CTOR.

virtual MAKVrExchange::DtMessageQueue::~DtMessageQueue ( )

virtual

Virtual DTOR.

MAKVrExchange::DtMessageQueue::DtMessageQueue ( const DtMessageQueue &  other )

private

Copy Ctor Not Implemented – Class Not Copiable.

Member Function Documentation

virtual bool MAKVrExchange::DtMessageQueue::isEmpty ( )

pure virtual

returns true if there are no messages to be read.

Implemented in MAKVrExchange::DtSubscribableMessageQueue.

virtual void* MAKVrExchange::DtMessageQueue::message ( unsigned int *  outSize = 0 )

pure virtual

Returns a pointer to the oldest message in the queue, returns 0 if there are no messages waiting in the queue.

Implemented in MAKVrExchange::DtSubscribableMessageQueue.

DtMessageQueue& MAKVrExchange::DtMessageQueue::operator= ( const DtMessageQueue &  other )

private

Assignment Operator Not Implemented – Class Not Copiable.

virtual std::ostream& MAKVrExchange::DtMessageQueue::printDataToStream ( std::ostream &  str ) const

pure virtual

Prints the internal state of the queue to a stream.

Implemented in MAKVrExchange::DtSubscribableMessageQueue.

virtual void MAKVrExchange::DtMessageQueue::sendMessage ( const void *  message, unsigned int  messageSize, bool  global = false  )

pure virtual

Inserts message of size messageSize into queue.

Implemented in MAKVrExchange::DtSubscribableMessageQueue.

---

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

• messageQueue.h