#include <mqueue.h>
Inheritance diagram for MessageQueue:
Definition at line 11 of file mqueue.h.
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 | |
MessageQueue (unsigned int nodeSize=256) | |
void | IsolatedInitialize (const NameValuePairs ¶meters) |
size_t | Put2 (const byte *begin, size_t length, int messageEnd, bool blocking) |
input multiple bytes for blocking or non-blocking processing | |
bool | IsolatedFlush (bool hardFlush, bool blocking) |
bool | IsolatedMessageSeriesEnd (bool blocking) |
lword | MaxRetrievable () const |
returns number of bytes that is currently ready for retrieval | |
bool | AnyRetrievable () const |
returns whether any bytes are currently ready for retrieval | |
size_t | TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true) |
upon return, byteCount contains number of bytes that have finished being transfered, and returns the number of bytes left in the current transfer block | |
size_t | CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const |
upon return, begin contains the start position of data yet to be finished copying, and returns the number of bytes left in the current transfer block | |
lword | TotalBytesRetrievable () const |
unsigned int | NumberOfMessages () const |
number of times MessageEnd() has been received minus messages retrieved or skipped | |
bool | GetNextMessage () |
start retrieving the next message | |
unsigned int | NumberOfMessagesInThisSeries () const |
unsigned int | NumberOfMessageSeries () const |
unsigned int | CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=NULL_CHANNEL) const |
const byte * | Spy (size_t &contiguousSize) const |
void | swap (MessageQueue &rhs) |
void | SetAutoSignalPropagation (int propagation) |
set propagation of automatically generated and transferred signals | |
int | GetAutoSignalPropagation () const |
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, CallStack const &callStack) |
wait on this object | |
SIGNALS | |
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 | |
Static Public Attributes | |
static const std::string | NULL_CHANNEL |
Static Protected Member Functions | |
static int | DecrementPropagation (int propagation) |
size_t MessageQueue::Put2 | ( | const byte * | begin, | |
size_t | length, | |||
int | messageEnd, | |||
bool | blocking | |||
) | [inline, virtual] |
input multiple bytes for blocking or non-blocking processing
messageEnd | means how many filters to signal MessageEnd to, including this one |
Implements BufferedTransformation.
lword 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 33 of file mqueue.h.
Referenced by CopyRangeTo2(), Spy(), and TransferTo2().
bool MessageQueue::GetNextMessage | ( | ) | [virtual] |
start retrieving the next message
Returns false if no more messages exist or this message is not completely retrieved.
Reimplemented from BufferedTransformation.
Definition at line 32 of file mqueue.cpp.
References AnyRetrievable(), and NumberOfMessages().
void AutoSignaling< BufferedTransformation >::SetAutoSignalPropagation | ( | int | propagation | ) | [inline, virtual, inherited] |
BufferedTransformation& BufferedTransformation::Ref | ( | ) | [inline, inherited] |
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 736 of file cryptlib.h.
virtual byte* BufferedTransformation::CreatePutSpace | ( | size_t & | size | ) | [inline, virtual, inherited] |
request space which can be written into by the caller, and then used as input to Put()
Reimplemented in MeterFilter, HashFilter, Redirector, OutputProxy, ArraySink, ArrayXorSink, ByteQueue, Multichannel< Filter >, and Multichannel< Sink >.
Definition at line 755 of file cryptlib.h.
Referenced by BufferedTransformation::ChannelCreatePutSpace(), and ArrayXorSink::CreatePutSpace().
virtual size_t BufferedTransformation::PutModifiable2 | ( | byte * | inString, | |
size_t | length, | |||
int | messageEnd, | |||
bool | blocking | |||
) | [inline, virtual, inherited] |
input multiple bytes that may be modified by callee for blocking or non-blocking processing
messageEnd | means how many filters to signal MessageEnd to, including this one |
Reimplemented in MeterFilter, FilterWithBufferedInput, OutputProxy, Multichannel< Filter >, and Multichannel< Sink >.
Definition at line 773 of file cryptlib.h.
Referenced by BufferedTransformation::ChannelPutModifiable2(), NetworkSource::DoPump(), and Filter::OutputModifiable().
void BufferedTransformation::GetWaitObjects | ( | WaitObjectContainer & | container, | |
CallStack const & | callStack | |||
) | [virtual, inherited] |
put wait objects into container
callStack | is used for tracing no wait loops, example: something.GetWaitObjects(c, CallStack("my func after X", 0));
|
Implements Waitable.
Reimplemented in Redirector, NetworkSource, and NetworkSink.
Definition at line 214 of file cryptlib.cpp.
References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetWaitObjects().
Referenced by NetworkSource::GetWaitObjects(), and BufferedTransformation::GetWaitObjects().
bool BufferedTransformation::Flush | ( | bool | hardFlush, | |
int | propagation = -1 , |
|||
bool | blocking = true | |||
) | [virtual, inherited] |
flush buffered input and/or output
hardFlush | is used to indicate whether all data should be flushed |
Reimplemented in Filter, Redirector, OutputProxy, SecretSharing, InformationDispersal, Unflushable< Filter >, Unflushable< Sink >, Unflushable< Multichannel< Filter > >, Multichannel< Filter >, and Multichannel< Sink >.
Definition at line 227 of file cryptlib.cpp.
References BufferedTransformation::AttachedTransformation().
Referenced by BufferedTransformation::ChannelFlush().
bool BufferedTransformation::MessageSeriesEnd | ( | int | propagation = -1 , |
|
bool | blocking = true | |||
) | [virtual, inherited] |
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 233 of file cryptlib.cpp.
References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::IsolatedMessageSeriesEnd().
Referenced by EqualityComparisonFilter::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelMessageSeriesEnd(), and EncodedObjectFilter::Put().
virtual bool BufferedTransformation::Attachable | ( | ) | [inline, virtual, inherited] |
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 963 of file cryptlib.h.
Referenced by BufferedTransformation::Attach().
bool Waitable::Wait | ( | unsigned long | milliseconds, | |
CallStack const & | callStack | |||
) | [inherited] |
wait on this object
same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container
Definition at line 388 of file wait.cpp.
References Waitable::GetWaitObjects(), and WaitObjectContainer::Wait().
Referenced by NetworkSink::DoFlush(), and NetworkSource::DoPump().