#include <network.h>
Inheritance diagram for NetworkSink:
Definition at line 116 of file network.h.
Public Member Functions | |
NetworkSink (unsigned int maxBufferSize, bool autoFlush) | |
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 | SetAutoFlush (bool autoFlush=true) |
unsigned int | GetMaxBufferSize () const |
unsigned int | GetCurrentBufferSize () const |
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 | |
INPUT | |
unsigned int | Put (byte inByte, bool blocking=true) |
input a byte for processing | |
unsigned int | Put (const byte *inString, unsigned int length, bool blocking=true) |
input multiple bytes | |
unsigned int | PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
input a 16-bit word | |
unsigned int | PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
input a 32-bit word | |
virtual byte * | CreatePutSpace (unsigned int &size) |
request space which can be written into by the caller, and then used as input to Put() | |
virtual bool | CanModifyInput () const |
unsigned int | PutModifiable (byte *inString, unsigned int length, bool blocking=true) |
input multiple bytes that may be modified by callee | |
bool | MessageEnd (int propagation=-1, bool blocking=true) |
unsigned int | PutMessageEnd (const byte *inString, unsigned int length, int propagation=-1, bool blocking=true) |
virtual unsigned int | PutModifiable2 (byte *inString, unsigned int length, int messageEnd, bool blocking) |
input multiple bytes that may be modified by callee for blocking or non-blocking processing | |
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 transfered signals | |
virtual int | GetAutoSignalPropagation () const |
RETRIEVAL OF ONE MESSAGE | |
virtual unsigned long | MaxRetrievable () const |
returns number of bytes that is currently ready for retrieval | |
virtual bool | AnyRetrievable () const |
returns whether any bytes are currently ready for retrieval | |
virtual unsigned int | Get (byte &outByte) |
try to retrieve a single byte | |
virtual unsigned int | Get (byte *outString, unsigned int getMax) |
try to retrieve multiple bytes | |
virtual unsigned int | Peek (byte &outByte) const |
peek at the next byte without removing it from the output buffer | |
virtual unsigned int | Peek (byte *outString, unsigned int peekMax) const |
peek at multiple bytes without removing them from the output buffer | |
unsigned int | GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
try to retrieve a 16-bit word | |
unsigned int | GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
try to retrieve a 32-bit word | |
unsigned int | PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
try to peek at a 16-bit word | |
unsigned int | PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
try to peek at a 32-bit word | |
unsigned long | TransferTo (BufferedTransformation &target, unsigned long transferMax=ULONG_MAX, const std::string &channel=NULL_CHANNEL) |
move transferMax bytes of the buffered output to target as input | |
virtual unsigned long | Skip (unsigned long skipMax=ULONG_MAX) |
discard skipMax bytes from the output buffer | |
unsigned long | CopyTo (BufferedTransformation &target, unsigned long copyMax=ULONG_MAX, const std::string &channel=NULL_CHANNEL) const |
copy copyMax bytes of the buffered output to target as input | |
unsigned long | CopyRangeTo (BufferedTransformation &target, unsigned long position, unsigned long copyMax=ULONG_MAX, const std::string &channel=NULL_CHANNEL) const |
copy copyMax bytes of the buffered output, starting at position (relative to current position), to target as input | |
RETRIEVAL OF MULTIPLE MESSAGES | |
virtual unsigned long | TotalBytesRetrievable () const |
virtual unsigned int | NumberOfMessages () const |
number of times MessageEnd() has been received minus messages retrieved or skipped | |
virtual bool | AnyMessages () const |
returns true if NumberOfMessages() > 0 | |
virtual bool | GetNextMessage () |
start retrieving the next message | |
virtual unsigned int | SkipMessages (unsigned int count=UINT_MAX) |
skip count number of messages | |
unsigned int | TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=NULL_CHANNEL) |
unsigned int | CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=NULL_CHANNEL) const |
virtual void | SkipAll () |
void | TransferAllTo (BufferedTransformation &target, const std::string &channel=NULL_CHANNEL) |
void | CopyAllTo (BufferedTransformation &target, const std::string &channel=NULL_CHANNEL) const |
virtual bool | GetNextMessageSeries () |
virtual unsigned int | NumberOfMessagesInThisSeries () const |
virtual unsigned int | NumberOfMessageSeries () const |
NON-BLOCKING TRANSFER OF OUTPUT | |
unsigned int | TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=NULL_CHANNEL, bool blocking=true) |
unsigned int | TransferAllTo2 (BufferedTransformation &target, const std::string &channel=NULL_CHANNEL, bool blocking=true) |
CHANNELS | |
unsigned int | ChannelPut (const std::string &channel, byte inByte, bool blocking=true) |
unsigned int | ChannelPut (const std::string &channel, const byte *inString, unsigned int length, bool blocking=true) |
unsigned int | ChannelPutModifiable (const std::string &channel, byte *inString, unsigned int length, bool blocking=true) |
unsigned int | ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
unsigned int | ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
bool | ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true) |
unsigned int | ChannelPutMessageEnd (const std::string &channel, const byte *inString, unsigned int length, int propagation=-1, bool blocking=true) |
virtual byte * | ChannelCreatePutSpace (const std::string &channel, unsigned int &size) |
virtual unsigned int | ChannelPut2 (const std::string &channel, const byte *begin, unsigned int length, int messageEnd, bool blocking) |
virtual unsigned int | ChannelPutModifiable2 (const std::string &channel, byte *begin, unsigned int length, int messageEnd, bool blocking) |
virtual void | ChannelInitialize (const std::string &channel, const NameValuePairs ¶meters=g_nullNameValuePairs, int propagation=-1) |
virtual bool | ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true) |
virtual bool | ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true) |
virtual void | SetRetrievalChannel (const std::string &channel) |
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 | |
Static Public Attributes | |
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 | |
int | DecrementPropagation (int propagation) |
|
input multiple bytes for blocking or non-blocking processing
Implements BufferedTransformation. Definition at line 129 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 157 of file network.cpp. References ByteQueue::CurrentSize(), Timer::ElapsedTime(), NetworkSender::GetSendResult(), INFINITE_TIME, ByteQueue::IsEmpty(), NetworkSender::MustWaitForResult(), NetworkSender::MustWaitToSend(), NetworkSender::Send(), 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 681 of file cryptlib.h. |
|
request space which can be written into by the caller, and then used as input to Put()
Definition at line 700 of file cryptlib.h. |
|
input multiple bytes that may be modified by callee for blocking or non-blocking processing
Reimplemented in FilterWithBufferedInput. Definition at line 718 of file cryptlib.h. References BufferedTransformation::Put2(). Referenced by BufferedTransformation::PutModifiable(). |
|
flush buffered input and/or output
Reimplemented in Filter. Definition at line 166 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(). |
|
mark end of a series of messages There should be a MessageEnd immediately before MessageSeriesEnd. Reimplemented in Filter. Definition at line 172 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(). |
|
set propagation of automatically generated and transfered signals propagation == 0 means do not automaticly generate signals Definition at line 758 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(). Definition at line 226 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::CopyTo(). |
|
start retrieving the next message Returns false if no more messages exist or this message is not completely retrieved. Definition at line 315 of file cryptlib.cpp. References BufferedTransformation::AnyMessages(), and BufferedTransformation::AttachedTransformation(). |
|
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 906 of file cryptlib.h. Referenced by BufferedTransformation::Attach(), BufferedTransformation::AttachedTransformation(), and BufferedTransformation::Detach(). |
|
wait on this object same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container Definition at line 247 of file wait.cpp. References Waitable::GetWaitObjects(), and WaitObjectContainer::Wait(). Referenced by NetworkSource::GeneralPump2(), and TimedFlush(). |