EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
EQueuePrivate Class Reference

The private queue class. More...

#include <eqpriv.h>

Inheritance diagram for EQueuePrivate:
EQueueBase

Public Member Functions

 EQueuePrivate ()
 Default constructor. More...
 
 ~EQueuePrivate ()
 Class destructor. More...
 
Void init (Int nMsgSize, Int nMsgCnt, Int queueId, Bool bMultipleReaders, Bool bMultipleWriters, EQueueBase::Mode eMode)
 Initializes the private message queue. More...
 
- Public Member Functions inherited from EQueueBase
Bool push (EQueueMessage &msg, Bool wait=True)
 Writes a message to the queue. More...
 
EQueueMessagepop (Bool wait=True)
 Retrieves the next message from the queue. More...
 
Void destroy ()
 Destroys the message queue. More...
 

Additional Inherited Members

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

Detailed Description

The private queue class.

Constructor & Destructor Documentation

◆ EQueuePrivate()

EQueuePrivate::EQueuePrivate ( )

Default constructor.

◆ ~EQueuePrivate()

EQueuePrivate::~EQueuePrivate ( )

Class destructor.

Member Function Documentation

◆ init()

Void EQueuePrivate::init ( Int  nMsgSize,
Int  nMsgCnt,
Int  queueId,
Bool  bMultipleReaders,
Bool  bMultipleWriters,
EQueueBase::Mode  eMode 
)
inline

Initializes the private message queue.

Parameters
nMsgSizethe maximum message size.
nMsgCntthe maximum number of messages that can be in the queue at one time.
queueIdthe queue identifier.
bMultipleReadersindicates whether or not that there are multiple readers.
bMultipleWritersindicates whether or not that there are multiple writers.
eModethe open mode.

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