This is a simple FIFO-Queue. More...

Public Member Functions
	CAQueue (UINT32 expectedElementSize=0)
	Give the size of the amount of data what you will add in one step.
	~CAQueue ()
	Deletes this Queue and all stored data.
SINT32	add (const void *buff, UINT32 size)
	Adds data to the Queue.
SINT32	close ()
	Closes the Queue (for writing).
SINT32	get (UINT8 pbuff, UINT32 psize)
	Gets up to psize number of bytes from the Queue.
SINT32	getOrWait (UINT8 pbuff, UINT32 psize)
	Gets data from the Queue or waits until some data is available, if the Queue is empty.
SINT32	getOrWait (UINT8 pbuff, UINT32 psize, UINT32 msTimeOut)
	Gets data from the Queue or waits until some data is available, if the Queue is empty or a timeout is reached.
SINT32	peek (UINT8 pbuff, UINT32 psize)
	Peeks data from the Queue.
SINT32	remove (UINT32 *psize)
	Removes data from the Queue.
SINT32	clean ()
	Removes any stored data from the Queue.
UINT32	getSize ()
	Returns the size of stored data in byte.
bool	isEmpty ()
	Returns true, if the Queue is empty.
bool	isClosed ()
	Returns true, if the Queue is closed.
Static Public Member Functions
static SINT32	test ()
	Method to test the Queue.
Private Attributes
QUEUE *	m_Queue
QUEUE *	m_lastElem
volatile UINT32	m_nQueueSize
volatile bool	m_bClosed
UINT32	m_nExpectedElementSize
CAMutex *	m_pcsQueue
CAConditionVariable *	m_pconvarSize

Detailed Description

This is a simple FIFO-Queue.

You can add data and get them back. This class is thread safe. TODO: The handling of getAndWait is not correct because remove could intercept.... Maybe we do not neeed an other Mutex other than then ConVar....

Constructor & Destructor Documentation

CAQueue::CAQueue ( UINT32 expectedElementSize = 0 )

Give the size of the amount of data what you will add in one step.

Used for optimizations. Use expectedElementSize=0, if you have no idea about the typicall amount of data added in one call to add().

References m_bClosed, m_lastElem, m_nExpectedElementSize, m_nQueueSize, m_pconvarSize, m_pcsQueue, and m_Queue.

Referenced by test().

CAQueue::~CAQueue ( )

Deletes this Queue and all stored data.

References clean(), m_pconvarSize, and m_pcsQueue.

Member Function Documentation

SINT32 CAQueue::add	(	const void *	buff,
		UINT32	size
	)

Adds data to the Queue.

Parameters:

buff	pointer to the data buffer
size	size of data to add

Return values:

E_UNKNOWN	in case of an error
E_SUCCESS	if succesful

References E_SUCCESS, E_UNKNOWN, _t_queue::index, CAMutex::lock(), m_lastElem, m_nQueueSize, m_pconvarSize, m_pcsQueue, m_Queue, _t_queue::next, _t_queue::pBuff, CAMsg::printMsg(), CAConditionVariable::signal(), _t_queue::size, and CAMutex::unlock().

Referenced by CAChain::addDataToUpstreamQueue(), CALastMix::clean(), CAFirstMix::clean(), CAFirstMixA::closeConnection(), MemFormatTarget::dumpMem(), fm_loopReadFromMix(), lm_loopReadFromMix(), CALastMixA::loop(), CAFirstMixB::loop(), CAFirstMixA::loop(), CALastMixB::loop(), mm_loopReadFromMixAfter(), mm_loopReadFromMixBefore(), CAFirstMixA::notifyAllUserChannels(), producer(), CAControlChannelDispatcher::sendMessages(), test(), and MemFormatTarget::writeChars().

SINT32 CAQueue::clean ( )

Removes any stored data from the Queue.

References E_SUCCESS, CAMutex::lock(), m_lastElem, m_nQueueSize, m_pcsQueue, m_Queue, _t_queue::next, _t_queue::pBuff, and CAMutex::unlock().

Referenced by CAFirstMixA::checkUserConnections(), CAChain::closeChainInternal(), CAChain::~CAChain(), and ~CAQueue().

SINT32 CAQueue::close ( )

Closes the Queue (for writing).

One can still read the remaing bytes out of the queue.

References E_SUCCESS, CAMutex::lock(), m_bClosed, m_pcsQueue, and CAMutex::unlock().

Referenced by CALastMixA::loop().

SINT32 CAQueue::get	(	UINT8 *	pbuff,
		UINT32 *	psize
	)

Gets up to psize number of bytes from the Queue.

The data is removed from the Queue.

Parameters:

pbuff	pointer to a buffer, there the data should be stored
psize	on call contains the size of pbuff, on return contains the size of returned data

Return values:

E_SUCCESS	if succesful
E_UNKNOWN	in case of an error

References E_SUCCESS, E_UNKNOWN, _t_queue::index, CAMutex::lock(), m_nQueueSize, m_pcsQueue, m_Queue, _t_queue::next, _t_queue::pBuff, _t_queue::size, and CAMutex::unlock().

Referenced by CAFirstMix::doUserLogin_internal(), CALastMixA::loop(), CAFirstMixB::loop(), CAFirstMixA::loop(), CALastMixB::loop(), CAFirstMixA::sendToUsers(), and test().

SINT32 CAQueue::getOrWait	(	UINT8 *	pbuff,
		UINT32 *	psize
	)

Gets data from the Queue or waits until some data is available, if the Queue is empty.

The data is removed from the Queue.

Parameters:

pbuff	pointer to a buffer, there the data should be stored
psize	on call contains the size of pbuff, on return contains the size of returned data

Return values:

E_SUCCESS	if succesful
E_UNKNOWN	in case of an error

References CAMutex::lock(), m_pconvarSize, m_Queue, CAMutex::unlock(), and CAConditionVariable::wait().

Referenced by consumer(), fm_loopSendToMix(), lm_loopSendToMix(), mm_loopSendToMixAfter(), and mm_loopSendToMixBefore().

SINT32 CAQueue::getOrWait	(	UINT8 *	pbuff,
		UINT32 *	psize,
		UINT32	msTimeout
	)

Gets data from the Queue or waits until some data is available, if the Queue is empty or a timeout is reached.

The data is removed from the Queue.

Parameters:

pbuff	pointer to a buffer, there the data should be stored
psize	on call contains the size of pbuff, on return contains the size of returned data
msTimeout	timeout in milli seconds

Return values: