The message queue base class. More...

#include <eqbase.h>

Inheritance diagram for EQueueBase:

Public Types
enum	Mode { ReadOnly, WriteOnly, ReadWrite }
	The queue access modes. More...

Public Member Functions
Bool	push (EQueueMessage &msg, Bool wait=True)
	Writes a message to the queue. More...

EQueueMessage *	pop (Bool wait=True)
	Retrieves the next message from the queue. More...

Void	destroy ()
	Destroys the message queue. More...

Friends
class	EQueuePublic

class	EQueuePrivate

Detailed Description

The message queue base class.

Member Enumeration Documentation

◆ Mode

enum EQueueBase::Mode

The queue access modes.

Enumerator
ReadOnly	provivdes read only access
WriteOnly	provides write only access
ReadWrite	provides read/write access

Member Function Documentation

◆ destroy()

Void EQueueBase::destroy ( )

Destroys the message queue.

◆ pop()

EQueueMessage * EQueueBase::pop ( Bool wait = True )

Retrieves the next message from the queue.

Parameters

wait	indicates whether to wait for a message or to return immediately.

Returns: a pointer to the successfully retrieved message otherwise NULL.

◆ push()

Bool EQueueBase::push	(	EQueueMessage &	msg,
		Bool	wait = `True`
	)

Writes a message to the queue.

Parameters

msg	the message to be written.
wait	indicated whether to wait for space to become available in the queue before writing the data.

Returns: True indicates that the message was successfully written, otherwise there was insufficient space to write the message.

Friends And Related Function Documentation

◆ EQueuePrivate

friend class EQueuePrivate

friend

◆ EQueuePublic

friend class EQueuePublic