#include <network.h>
Inheritance diagram for NetworkSink:
Definition at line 126 of file network.h.
SIGNALS | |
virtual void | IsolatedInitialize (const NameValuePairs ¶meters) |
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 | |
NetworkSink (unsigned int maxBufferSize, unsigned int autoFlushBound) | |
unsigned int | GetMaxWaitObjectCount () const |
maximum number of wait objects that this object can return | |
void | GetWaitObjects (WaitObjectContainer &container) |
put wait objects into container | |
unsigned int | Put2 (const byte *inString, unsigned int length, int messageEnd, bool blocking) |
input multiple bytes for blocking or non-blocking processing | |
unsigned int | TimedFlush (unsigned long maxTime, unsigned int targetSize=0) |
flush to device for no more than maxTime milliseconds | |
void | SetMaxBufferSize (unsigned int maxBufferSize) |
void | SetAutoFlushBound (unsigned int bound) |
set a bound which will cause sink to flush if exceeded by GetCurrentBufferSize() | |
unsigned int | GetMaxBufferSize () const |
unsigned int | GetCurrentBufferSize () const |
void | ClearBuffer () |
float | ComputeCurrentSpeed () |
compute the current speed of this sink in bytes per second | |
float | GetMaxObservedSpeed () const |
get the maximum observed speed of this sink in bytes per second | |
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 |
Protected Member Functions | |
virtual NetworkSender & | AccessSender ()=0 |
const NetworkSender & | GetSender () const |
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 |
Static Protected Member Functions | |
static int | DecrementPropagation (int propagation) |
|
input multiple bytes for blocking or non-blocking processing
Implements BufferedTransformation. Definition at line 190 of file network.cpp. References ByteQueue::CurrentSize(), ByteQueue::FinalizeLazyPut(), INFINITE_TIME, ByteQueue::LazyPut(), NetworkSender::SendEof(), TimedFlush(), and ByteQueue::UndoLazyPut(). |
|
flush to device for no more than maxTime milliseconds This function will repeatedly attempt to flush data to some device, until the queue is empty, or a total of maxTime milliseconds have elapsed. If maxTime == 0, at least one attempt will be made to flush some data, but it is likely that not all queued data will be flushed, even if the device is ready to receive more data without waiting. If you want to flush as much data as possible without waiting for the device, call this function in a loop. For example: while (sink.TimedFlush(0) > 0) {}
Implements NonblockingSink. Definition at line 227 of file network.cpp. References ByteQueue::AnyRetrievable(), ComputeCurrentSpeed(), ByteQueue::CurrentSize(), TimerBase::ElapsedTime(), NetworkSender::GetSendResult(), INFINITE_TIME, NetworkSender::MustWaitForResult(), NetworkSender::MustWaitToSend(), NetworkSender::Send(), BufferedTransformation::Skip(), ByteQueue::Spy(), and Waitable::Wait(). Referenced by Put2(). |
|
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. |
|
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 735 of file cryptlib.h. Referenced by BufferedTransformation::ChannelCreatePutSpace(), and ArrayXorSink::CreatePutSpace(). |
|
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. |
|
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 in FileStore, RandomNumberStore, NullStore, MessageQueue, ByteQueue, ByteQueue::Walker, and RandomPool. Definition at line 247 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(), BufferedTransformation::CopyTo(), and BufferedTransformation::MaxRetrievable(). Referenced by RandomNumberStore::AnyRetrievable(), Integer::BERDecode(), Integer::Decode(), DL_GroupParameters_EC< EC >::Initialize(), BufferedTransformation::MaxRetrievable(), EcRecommendedParameters< ECP >::NewEC(), EcRecommendedParameters< EC2N >::NewEC(), Integer::OpenPGPDecode(), and BufferedTransformation::TotalBytesRetrievable(). |
|
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 TimedFlush(). |