---

MessageQueue Class Reference

Message Queue. More...

#include <mqueue.h>

Inheritance diagram for MessageQueue:

List of all members.

Public Methods
	MessageQueue (unsigned int nodeSize=256)
void	Put (byte inByte)
	input a byte for processing. More...
void	Put (const byte *inString,unsigned int length)
	input multiple bytes. More...
unsigned long	MaxRetrievable ()const
	returns number of bytes that is currently ready for retrieval. More...
bool	AnyRetrievable ()const
	returns whether any bytes are currently ready for retrieval. More...
unsigned long	TransferTo (BufferedTransformation &target,unsigned long transferMax=ULONG_MAX)
	move transferMax bytes of the buffered output to target as input. More...
unsigned long	CopyTo (BufferedTransformation &target,unsigned long copyMax=ULONG_MAX)const
	copy copyMax bytes of the buffered output to target as input. More...
void	MessageEnd (int=-1)
	mark end of an input segment, message, or packet. More...
unsigned long	TotalBytesRetrievable ()const
unsigned int	NumberOfMessages ()const
	number of times MessageEnd() has been received minus messages retrieved or skipped. More...
bool	RetrieveNextMessage ()
unsigned int	CopyMessagesTo (BufferedTransformation &target,unsigned int count=UINT_MAX)const
void	swap (MessageQueue &rhs)

---

Detailed Description

Message Queue.

Definition at line 11 of file mqueue.h.

---

Constructor & Destructor Documentation

MessageQueue::MessageQueue ( unsigned int nodeSize = 256 )

Definition at line 8 of file mqueue.cpp.

---

Member Function Documentation

bool MessageQueue::AnyRetrievable ( ) const [inline, virtual]

returns whether any bytes are currently ready for retrieval. Reimplemented from BufferedTransformation. Definition at line 23 of file mqueue.h.

unsigned int MessageQueue::CopyMessagesTo ( BufferedTransformation & target, unsigned int count = UINT_MAX ) const [virtual]

Reimplemented from BufferedTransformation. Definition at line 24 of file mqueue.cpp.

unsigned long MessageQueue::CopyTo ( BufferedTransformation & target, unsigned long copyMax = ULONG_MAX ) const [inline, virtual]

copy copyMax bytes of the buffered output to target as input. Reimplemented from BufferedTransformation. Definition at line 28 of file mqueue.h.

unsigned long MessageQueue::MaxRetrievable ( ) const [inline, virtual]

returns number of bytes that is currently ready for retrieval. All retrieval functions return the actual number of bytes retrieved, which is the lesser of the request number and MaxRetrievable(). Reimplemented from BufferedTransformation. Definition at line 21 of file mqueue.h.

void MessageQueue::MessageEnd ( int propagation = -1 ) [inline, virtual]

mark end of an input segment, message, or packet. propagation != 0 means pass on the signal to attached BufferedTransformation objects, with propagation decremented at each step until it reaches 0. -1 means unlimited propagation. Reimplemented from BufferedTransformation. Definition at line 31 of file mqueue.h.

unsigned int MessageQueue::NumberOfMessages ( ) const [inline, virtual]

number of times MessageEnd() has been received minus messages retrieved or skipped. Reimplemented from BufferedTransformation. Definition at line 36 of file mqueue.h.

void MessageQueue::Put ( const byte * inString, unsigned int length ) [inline, virtual]

input multiple bytes. Reimplemented from BufferedTransformation. Definition at line 18 of file mqueue.h.

void MessageQueue::Put ( byte inByte ) [inline, virtual]

input a byte for processing. Reimplemented from BufferedTransformation. Definition at line 16 of file mqueue.h.

bool MessageQueue::RetrieveNextMessage ( )

Definition at line 13 of file mqueue.cpp.

unsigned long MessageQueue::TotalBytesRetrievable ( ) const [inline, virtual]

Reimplemented from BufferedTransformation. Definition at line 34 of file mqueue.h.

unsigned long MessageQueue::TransferTo ( BufferedTransformation & target, unsigned long transferMax = ULONG_MAX ) [inline, virtual]

move transferMax bytes of the buffered output to target as input. Reimplemented from BufferedTransformation. Definition at line 26 of file mqueue.h.

void MessageQueue::swap ( MessageQueue & rhs )

Definition at line 38 of file mqueue.cpp.

---

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

• mqueue.h
• mqueue.cpp

---