Crypto++  8.8
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
MessageQueue Class Reference

Data structure used to store messages. More...

+ Inheritance diagram for MessageQueue:

Public Member Functions

 MessageQueue (unsigned int nodeSize=256)
 Construct a MessageQueue. More...
 
void IsolatedInitialize (const NameValuePairs &parameters)
 Initialize or reinitialize this object, without signal propagation. More...
 
size_t Put2 (const byte *begin, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing. More...
 
bool IsolatedFlush (bool hardFlush, bool blocking)
 Flushes data buffered by this object, without signal propagation. More...
 
bool IsolatedMessageSeriesEnd (bool blocking)
 Marks the end of a series of messages, without signal propagation. More...
 
lword MaxRetrievable () const
 Provides the number of bytes ready for retrieval. More...
 
bool AnyRetrievable () const
 Determines whether bytes are ready for retrieval. More...
 
size_t TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer bytes from this object to another BufferedTransformation. More...
 
size_t CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
 Copy bytes from this object to another BufferedTransformation. More...
 
lword TotalBytesRetrievable () const
 Provides the number of bytes ready for retrieval. More...
 
unsigned int NumberOfMessages () const
 Provides the number of meesages processed by this object. More...
 
bool GetNextMessage ()
 Start retrieving the next message. More...
 
unsigned int NumberOfMessagesInThisSeries () const
 Provides the number of messages in a series. More...
 
unsigned int NumberOfMessageSeries () const
 Provides the number of messages in a series. More...
 
unsigned int CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation. More...
 
const byteSpy (size_t &contiguousSize) const
 Peek data in the queue. More...
 
void swap (MessageQueue &rhs)
 Swap contents with another MessageQueue. More...
 
- Public Member Functions inherited from AutoSignaling< BufferedTransformation >
 AutoSignaling (int propagation=-1)
 Construct an AutoSignaling. More...
 
void SetAutoSignalPropagation (int propagation)
 Set propagation of automatically generated and transferred signals. More...
 
int GetAutoSignalPropagation () const
 Retrieve automatic signal propagation value. More...
 
- Public Member Functions inherited from BufferedTransformation
 BufferedTransformation ()
 Construct a BufferedTransformation.
 
BufferedTransformationRef ()
 Provides a reference to this object. More...
 
virtual bool Attachable ()
 Determines whether the object allows attachment. More...
 
virtual BufferedTransformationAttachedTransformation ()
 Returns the object immediately attached to this object. More...
 
virtual const BufferedTransformationAttachedTransformation () const
 Returns the object immediately attached to this object. More...
 
virtual void Detach (BufferedTransformation *newAttachment=NULL)
 Delete the current attachment chain and attach a new one. More...
 
virtual void Attach (BufferedTransformation *newAttachment)
 Add newAttachment to the end of attachment chain. More...
 
size_t Put (byte inByte, bool blocking=true)
 Input a byte for processing. More...
 
size_t Put (const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing. More...
 
size_t PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 16-bit word for processing. More...
 
size_t PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 32-bit word for processing. More...
 
size_t PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 64-bit word for processing. More...
 
virtual byteCreatePutSpace (size_t &size)
 Request space which can be written into by the caller. More...
 
virtual bool CanModifyInput () const
 Determines whether input can be modified by the callee. More...
 
size_t PutModifiable (byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee. More...
 
bool MessageEnd (int propagation=-1, bool blocking=true)
 Signals the end of messages to the object. More...
 
size_t PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true)
 Input multiple bytes for processing and signal the end of a message. More...
 
virtual size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee. More...
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects.
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects. More...
 
virtual void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 Initialize or reinitialize this object, with signal propagation. More...
 
virtual bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output, with signal propagation. More...
 
virtual bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 Marks the end of a series of messages, with signal propagation. More...
 
virtual size_t Get (byte &outByte)
 Retrieve a 8-bit byte. More...
 
virtual size_t Get (byte *outString, size_t getMax)
 Retrieve a block of bytes. More...
 
virtual size_t Peek (byte &outByte) const
 Peek a 8-bit byte. More...
 
virtual size_t Peek (byte *outString, size_t peekMax) const
 Peek a block of bytes. More...
 
size_t GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 16-bit word. More...
 
size_t GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 32-bit word. More...
 
size_t GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 64-bit word. More...
 
size_t PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 16-bit word. More...
 
size_t PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 32-bit word. More...
 
size_t PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 64-bit word. More...
 
lword TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL)
 move transferMax bytes of the buffered output to target as input More...
 
virtual lword Skip (lword skipMax=LWORD_MAX)
 Discard skipMax bytes from the output buffer. More...
 
lword CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy bytes from this object to another BufferedTransformation. More...
 
lword CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy bytes from this object using an index to another BufferedTransformation. More...
 
virtual bool AnyMessages () const
 Determines if any messages are available for retrieval. More...
 
virtual unsigned int SkipMessages (unsigned int count=UINT_MAX)
 Skip a number of meessages. More...
 
unsigned int TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
 Transfer messages from this object to another BufferedTransformation. More...
 
unsigned int CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation. More...
 
virtual void SkipAll ()
 Skip all messages in the series.
 
void TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
 Transfer all bytes from this object to another BufferedTransformation. More...
 
void CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation. More...
 
virtual bool GetNextMessageSeries ()
 Retrieve the next message in a series. More...
 
size_t TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer messages from this object to another BufferedTransformation. More...
 
size_t TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer all bytes from this object to another BufferedTransformation. More...
 
size_t ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
 Input a byte for processing on a channel. More...
 
size_t ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing on a channel. More...
 
size_t ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee on a channel. More...
 
size_t ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 16-bit word for processing on a channel. More...
 
size_t ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 32-bit word for processing on a channel. More...
 
size_t ChannelPutWord64 (const std::string &channel, word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 64-bit word for processing on a channel. More...
 
bool ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Signal the end of a message. More...
 
size_t ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true)
 Input multiple bytes for processing and signal the end of a message. More...
 
virtual byteChannelCreatePutSpace (const std::string &channel, size_t &size)
 Request space which can be written into by the caller. More...
 
virtual size_t ChannelPut2 (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing on a channel. More...
 
virtual size_t ChannelPutModifiable2 (const std::string &channel, byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee on a channel. More...
 
virtual bool ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output on a channel. More...
 
virtual bool ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Marks the end of a series of messages on a channel. More...
 
virtual void SetRetrievalChannel (const std::string &channel)
 Sets the default retrieval channel. More...
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms. More...
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm. More...
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object. More...
 
- Public Member Functions inherited from Waitable
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object. More...
 

Detailed Description

Data structure used to store messages.

The queue is implemented with a ByteQueue.

See also
MessageQueue on the Crypto++ wiki.
Since
Crypto++ 2.0

Definition at line 23 of file mqueue.h.

Constructor & Destructor Documentation

◆ MessageQueue()

MessageQueue::MessageQueue ( unsigned int  nodeSize = 256)

Construct a MessageQueue.

Parameters
nodeSizethe initial node size

Member Function Documentation

◆ IsolatedInitialize()

void MessageQueue::IsolatedInitialize ( const NameValuePairs parameters)
inlinevirtual

Initialize or reinitialize this object, without signal propagation.

Parameters
parametersa set of NameValuePairs to initialize this object
Exceptions
NotImplemented

IsolatedInitialize() is used to initialize or reinitialize an object using a variable number of arbitrarily typed arguments. The function avoids the need for multiple constructors providing all possible combintations of configurable parameters.

IsolatedInitialize() does not call Initialize() on attached transformations. If initialization should be propagated, then use the Initialize() function.

If a derived class does not override IsolatedInitialize(), then the base class throws NotImplemented.

Reimplemented from BufferedTransformation.

Definition at line 33 of file mqueue.h.

◆ Put2()

size_t MessageQueue::Put2 ( const byte inString,
size_t  length,
int  messageEnd,
bool  blocking 
)
inlinevirtual

Input multiple bytes for processing.

Parameters
inStringthe byte buffer to process
lengththe size of the string, in bytes
messageEndmeans how many filters to signal MessageEnd() to, including this one
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain to be processed (i.e., bytes not processed). 0 indicates all bytes were processed.

Derived classes must implement Put2().

Implements BufferedTransformation.

Definition at line 35 of file mqueue.h.

◆ IsolatedFlush()

bool MessageQueue::IsolatedFlush ( bool  hardFlush,
bool  blocking 
)
inlinevirtual

Flushes data buffered by this object, without signal propagation.

Parameters
hardFlushindicates whether all data should be flushed
blockingspecifies whether the object should block when processing input
Returns
true if the flush was successful, false otherwise
Note
hardFlush must be used with care

Implements BufferedTransformation.

Definition at line 47 of file mqueue.h.

◆ IsolatedMessageSeriesEnd()

bool MessageQueue::IsolatedMessageSeriesEnd ( bool  blocking)
inlinevirtual

Marks the end of a series of messages, without signal propagation.

Parameters
blockingspecifies whether the object should block when completing the processing on the current series of messages
Returns
true if the message was successful, false otherwise

Reimplemented from BufferedTransformation.

Definition at line 49 of file mqueue.h.

◆ MaxRetrievable()

lword MessageQueue::MaxRetrievable ( ) const
inlinevirtual

Provides the number of bytes ready for retrieval.

Returns
the number of bytes ready for retrieval

The number of bytes available are dependent on the source. If an exact value is available, then the exact value is returned. The exact value can include 0 if the source is exhausted.

Some stream-based sources do not allow seeking() on the underlying stream, such as some FileSource(). If the stream does not allow seeking() then MaxRetrievable() returns LWORD_MAX to indicate there are still bytes to be retrieved.

Reimplemented from BufferedTransformation.

Definition at line 52 of file mqueue.h.

◆ AnyRetrievable()

bool MessageQueue::AnyRetrievable ( ) const
inlinevirtual

Determines whether bytes are ready for retrieval.

Returns
true if bytes are available for retrieval, false otherwise

Reimplemented from BufferedTransformation.

Definition at line 54 of file mqueue.h.

◆ TransferTo2()

size_t MessageQueue::TransferTo2 ( BufferedTransformation target,
lword byteCount,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
)
virtual

Transfer bytes from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
byteCountthe number of bytes to transfer
channelthe channel on which the transfer should occur
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the transfer block (i.e., bytes not transferred)

TransferTo2() removes bytes from this object and moves them to the destination. Transfer begins at the index position in the current stream, and not from an absolute position in the stream.

byteCount is an IN and OUT parameter. When the call is made, byteCount is the requested size of the transfer. When the call returns, byteCount is the number of bytes that were transferred.

Implements BufferedTransformation.

◆ CopyRangeTo2()

size_t MessageQueue::CopyRangeTo2 ( BufferedTransformation target,
lword begin,
lword  end = LWORD_MAX,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
) const
virtual

Copy bytes from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
beginthe 0-based index of the first byte to copy in the stream
endthe 0-based index of the last byte to copy in the stream
channelthe channel on which the transfer should occur
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the copy block (i.e., bytes not copied)

CopyRangeTo2 copies bytes from this object to the destination. The bytes are not removed from this object. Copying begins at the index position in the current stream, and not from an absolute position in the stream.

begin is an IN and OUT parameter. When the call is made, begin is the starting position of the copy. When the call returns, begin is the position of the first byte that was not copied (which may be different than end). begin can be used for subsequent calls to CopyRangeTo2().

Implements BufferedTransformation.

◆ TotalBytesRetrievable()

lword MessageQueue::TotalBytesRetrievable ( ) const
inlinevirtual

Provides the number of bytes ready for retrieval.

Returns
the number of bytes ready for retrieval

Reimplemented from BufferedTransformation.

Definition at line 60 of file mqueue.h.

◆ NumberOfMessages()

unsigned int MessageQueue::NumberOfMessages ( ) const
inlinevirtual

Provides the number of meesages processed by this object.

Returns
the number of meesages processed by this object

NumberOfMessages returns number of times MessageEnd() has been received minus messages retrieved or skipped

Reimplemented from BufferedTransformation.

Definition at line 62 of file mqueue.h.

◆ GetNextMessage()

bool MessageQueue::GetNextMessage ( )
virtual

Start retrieving the next message.

Returns
true if a message is ready for retrieval

GetNextMessage() returns true if a message is ready for retrieval; false if no more messages exist or this message is not completely retrieved.

Reimplemented from BufferedTransformation.

◆ NumberOfMessagesInThisSeries()

unsigned int MessageQueue::NumberOfMessagesInThisSeries ( ) const
inlinevirtual

Provides the number of messages in a series.

Returns
the number of messages in this series

Reimplemented from BufferedTransformation.

Definition at line 66 of file mqueue.h.

◆ NumberOfMessageSeries()

unsigned int MessageQueue::NumberOfMessageSeries ( ) const
inlinevirtual

Provides the number of messages in a series.

Returns
the number of messages in this series

Reimplemented from BufferedTransformation.

Definition at line 68 of file mqueue.h.

◆ CopyMessagesTo()

unsigned int MessageQueue::CopyMessagesTo ( BufferedTransformation target,
unsigned int  count = UINT_MAX,
const std::string &  channel = DEFAULT_CHANNEL 
) const

Copy messages from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
countthe number of messages to copy
channelthe channel on which the transfer should occur
Returns
the number of messages that remain in the copy (i.e., messages not copied)

◆ Spy()

const byte* MessageQueue::Spy ( size_t &  contiguousSize) const

Peek data in the queue.

Parameters
contiguousSizethe size of the data

Spy() peeks at data at the head of the queue. Spy() does not remove data from the queue.

The data's size is returned in contiguousSize. Spy() returns the size of the first message in the list.

◆ swap()

void MessageQueue::swap ( MessageQueue rhs)

Swap contents with another MessageQueue.

Parameters
rhsthe other MessageQueue

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