#include <queue.h>
Inheritance diagram for ByteQueue:
Definition at line 16 of file queue.h.
SIGNALS | |
virtual bool | IsolatedMessageSeriesEnd (bool blocking) |
virtual void | Initialize (const NameValuePairs ¶meters=g_nullNameValuePairs, int propagation=-1) |
initialize or reinitialize this object | |
virtual bool | Flush (bool hardFlush, int propagation=-1, bool blocking=true) |
flush buffered input and/or output | |
virtual bool | MessageSeriesEnd (int propagation=-1, bool blocking=true) |
mark end of a series of messages | |
virtual void | SetAutoSignalPropagation (int propagation) |
set propagation of automatically generated and transferred signals | |
virtual int | GetAutoSignalPropagation () const |
ATTACHMENT | |
virtual bool | Attachable () |
returns whether this object allows attachment | |
virtual BufferedTransformation * | AttachedTransformation () |
returns the object immediately attached to this object or NULL for no attachment | |
virtual const BufferedTransformation * | AttachedTransformation () const |
virtual void | Detach (BufferedTransformation *newAttachment=0) |
delete the current attachment chain and replace it with newAttachment | |
virtual void | Attach (BufferedTransformation *newAttachment) |
add newAttachment to the end of attachment chain | |
Public Member Functions | |
ByteQueue (unsigned int nodeSize=0) | |
ByteQueue (const ByteQueue ©) | |
~ByteQueue () | |
unsigned long | MaxRetrievable () const |
returns number of bytes that is currently ready for retrieval | |
bool | AnyRetrievable () const |
returns whether any bytes are currently ready for retrieval | |
void | IsolatedInitialize (const NameValuePairs ¶meters) |
byte * | CreatePutSpace (unsigned int &size) |
request space which can be written into by the caller, and then used as input to Put() | |
unsigned int | Put2 (const byte *inString, unsigned int length, int messageEnd, bool blocking) |
input multiple bytes for blocking or non-blocking processing | |
unsigned int | Get (byte &outByte) |
try to retrieve a single byte | |
unsigned int | Get (byte *outString, unsigned int getMax) |
try to retrieve multiple bytes | |
unsigned int | Peek (byte &outByte) const |
peek at the next byte without removing it from the output buffer | |
unsigned int | Peek (byte *outString, unsigned int peekMax) const |
peek at multiple bytes without removing them from the output buffer | |
unsigned int | TransferTo2 (BufferedTransformation &target, unsigned long &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true) |
unsigned int | CopyRangeTo2 (BufferedTransformation &target, unsigned long &begin, unsigned long end=ULONG_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const |
void | SetNodeSize (unsigned int nodeSize) |
unsigned long | CurrentSize () const |
bool | IsEmpty () const |
void | Clear () |
void | Unget (byte inByte) |
void | Unget (const byte *inString, unsigned int length) |
const byte * | Spy (unsigned int &contiguousSize) const |
void | LazyPut (const byte *inString, unsigned int size) |
void | LazyPutModifiable (byte *inString, unsigned int size) |
void | UndoLazyPut (unsigned int size) |
void | FinalizeLazyPut () |
ByteQueue & | operator= (const ByteQueue &rhs) |
bool | operator== (const ByteQueue &rhs) const |
byte | operator[] (unsigned long i) const |
void | swap (ByteQueue &rhs) |
bool | IsolatedFlush (bool hardFlush, bool blocking) |
BufferedTransformation & | Ref () |
return a reference to this object | |
virtual std::string | AlgorithmName () const |
returns name of this algorithm, not universally implemented yet | |
virtual Clonable * | Clone () const |
this is not implemented by most classes yet | |
bool | Wait (unsigned long milliseconds) |
wait on this object | |
Static Public Attributes | |
static const std::string | NULL_CHANNEL |
Static Protected Member Functions | |
static int | DecrementPropagation (int propagation) |
Friends | |
class | Walker |
Classes | |
class | Walker |
|
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 23 of file queue.h. Referenced by Integer::GenerateRandomNoThrow(). |
|
request space which can be written into by the caller, and then used as input to Put()
Reimplemented from BufferedTransformation. Definition at line 410 of file queue.cpp. References ByteQueueNode::buf, FinalizeLazyPut(), ByteQueueNode::m_tail, ByteQueueNode::MaxSize(), and ByteQueueNode::next. |
|
input multiple bytes for blocking or non-blocking processing
Implements BufferedTransformation. Definition at line 216 of file queue.cpp. References FinalizeLazyPut(), ByteQueueNode::next, and ByteQueueNode::Put(). |
|
return a reference to this object This function is useful for passing a temporary BufferedTransformation object to a function that takes a non-const reference. Definition at line 716 of file cryptlib.h. |
|
input multiple bytes that may be modified by callee for blocking or non-blocking processing
Reimplemented in MeterFilter, FilterWithBufferedInput, OutputProxy, Multichannel< Filter >, and Multichannel< Sink >. Definition at line 753 of file cryptlib.h. Referenced by BufferedTransformation::ChannelPutModifiable2(), NetworkSource::GeneralPump2(), and Filter::OutputModifiable(). |
|
flush buffered input and/or output
Reimplemented in Filter, Redirector, OutputProxy, SecretSharing, InformationDispersal, Unflushable< Filter >, Unflushable< Sink >, Unflushable< Multichannel< Filter > >, Multichannel< Filter >, and Multichannel< Sink >. Definition at line 195 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(). Referenced by BufferedTransformation::ChannelFlush(). |
|
mark end of a series of messages There should be a MessageEnd immediately before MessageSeriesEnd. Reimplemented in Filter, Redirector, OutputProxy, Multichannel< Filter >, and Multichannel< Sink >. Definition at line 201 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::IsolatedMessageSeriesEnd(). Referenced by EqualityComparisonFilter::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelMessageSeriesEnd(), and EncodedObjectFilter::Put(). |
|
set propagation of automatically generated and transferred signals propagation == 0 means do not automaticly generate signals Reimplemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, SourceTemplate< StringStore >, AutoSignaling< BufferedTransformation >, AutoSignaling< InputRejecting< BufferedTransformation > >, AutoSignaling< Filter >, AutoSignaling< Source >, and AutoSignaling< Unflushable< Multichannel< Filter > > >. Definition at line 793 of file cryptlib.h. |
|
start retrieving the next message Returns false if no more messages exist or this message is not completely retrieved. Reimplemented in MessageQueue, and Store. Definition at line 336 of file cryptlib.cpp. References BufferedTransformation::AnyMessages(), BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetNextMessage(). Referenced by BufferedTransformation::GetNextMessage(), and BufferedTransformation::TransferMessagesTo2(). |
|
returns whether this object allows attachment Some BufferedTransformation objects (e.g. Filter objects) allow other BufferedTransformation objects to be attached. When this is done, the first object instead of buffering its output, sents that output to the attached object as input. The entire attachment chain is deleted when the anchor object is destructed. Reimplemented in Filter. Definition at line 939 of file cryptlib.h. Referenced by BufferedTransformation::Attach(). |
|
wait on this object same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container Definition at line 321 of file wait.cpp. References Waitable::GetWaitObjects(), and WaitObjectContainer::Wait(). Referenced by NetworkSource::GeneralPump2(), and NetworkSink::TimedFlush(). |