#include <socketft.h>
Inheritance diagram for SocketSink:
Definition at line 207 of file socketft.h.
Public Member Functions | |
SocketSink (socket_t s=INVALID_SOCKET, unsigned int maxBufferSize=0, unsigned int autoFlushBound=16 *1024) | |
void | SendEof () |
unsigned int | GetMaxWaitObjectCount () const |
void | GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack) |
size_t | Put2 (const byte *inString, size_t length, int messageEnd, bool blocking) |
input multiple bytes for blocking or non-blocking processing | |
void | SetMaxBufferSize (size_t maxBufferSize) |
void | SetAutoFlushBound (size_t bound) |
set a bound which will cause sink to flush if exceeded by GetCurrentBufferSize() | |
size_t | GetMaxBufferSize () const |
size_t | GetCurrentBufferSize () const |
void | ClearBuffer () |
bool | EofPending () const |
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) |
lword | TimedFlush (unsigned long maxTime, size_t targetSize=0) |
flush to device for no more than maxTime milliseconds | |
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 | |
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 | |
lword | GetMaxBytesPerSecond () const |
void | SetMaxBytesPerSecond (lword v) |
lword | ComputeCurrentTransceiveLimit () |
double | TimeToNextTransceive () |
void | NoteTransceive (lword size) |
bool | GetOwnership () const |
void | SetOwnership (bool own) |
operator socket_t () | |
socket_t | GetSocket () const |
void | AttachSocket (socket_t s, bool own=false) |
socket_t | DetachSocket () |
void | CloseSocket () |
void | Create (int nType=SOCK_STREAM) |
void | Bind (unsigned int port, const char *addr=NULL) |
void | Bind (const sockaddr *psa, socklen_t saLen) |
void | Listen (int backlog=5) |
bool | Connect (const char *addr, unsigned int port) |
bool | Connect (const sockaddr *psa, socklen_t saLen) |
bool | Accept (Socket &s, sockaddr *psa=NULL, socklen_t *psaLen=NULL) |
void | GetSockName (sockaddr *psa, socklen_t *psaLen) |
void | GetPeerName (sockaddr *psa, socklen_t *psaLen) |
unsigned int | Send (const byte *buf, size_t bufLen, int flags=0) |
unsigned int | Receive (byte *buf, size_t bufLen, int flags=0) |
void | ShutDown (int how=SD_SEND) |
void | IOCtl (long cmd, unsigned long *argp) |
bool | SendReady (const timeval *timeout) |
bool | ReceiveReady (const timeval *timeout) |
virtual void | HandleError (const char *operation) const |
void | CheckAndHandleError_int (const char *operation, int result) const |
void | CheckAndHandleError (const char *operation, socket_t result) const |
void | CheckAndHandleError (const char *operation, BOOL result) const |
void | CheckAndHandleError (const char *operation, bool result) const |
INPUT | |
size_t | Put (byte inByte, bool blocking=true) |
input a byte for processing | |
size_t | Put (const byte *inString, size_t length, bool blocking=true) |
input multiple bytes | |
size_t | PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
input a 16-bit word | |
size_t | PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
input a 32-bit word | |
virtual byte * | CreatePutSpace (size_t &size) |
request space which can be written into by the caller, and then used as input to Put() | |
virtual bool | CanModifyInput () const |
size_t | PutModifiable (byte *inString, size_t length, bool blocking=true) |
input multiple bytes that may be modified by callee | |
bool | MessageEnd (int propagation=-1, bool blocking=true) |
size_t | PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true) |
virtual size_t | PutModifiable2 (byte *inString, size_t 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 transferred signals | |
virtual int | GetAutoSignalPropagation () const |
RETRIEVAL OF ONE MESSAGE | |
virtual lword | 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 size_t | Get (byte &outByte) |
try to retrieve a single byte | |
virtual size_t | Get (byte *outString, size_t getMax) |
try to retrieve multiple bytes | |
virtual size_t | Peek (byte &outByte) const |
peek at the next byte without removing it from the output buffer | |
virtual size_t | Peek (byte *outString, size_t peekMax) const |
peek at multiple bytes without removing them from the output buffer | |
size_t | GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
try to retrieve a 16-bit word | |
size_t | GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
try to retrieve a 32-bit word | |
size_t | PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const |
try to peek at a 16-bit word | |
size_t | PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const |
try to peek at a 32-bit word | |
lword | TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=NULL_CHANNEL) |
move transferMax bytes of the buffered output to target as input | |
virtual lword | Skip (lword skipMax=LWORD_MAX) |
discard skipMax bytes from the output buffer | |
lword | CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=NULL_CHANNEL) const |
copy copyMax bytes of the buffered output to target as input | |
lword | CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_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 lword | 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 | |
size_t | TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=NULL_CHANNEL, bool blocking=true) |
upon return, messageCount contains number of messages that have finished being transfered, and returns the number of bytes left in the current transfer block | |
size_t | TransferAllTo2 (BufferedTransformation &target, const std::string &channel=NULL_CHANNEL, bool blocking=true) |
returns the number of bytes left in the current transfer block | |
CHANNELS | |
size_t | ChannelPut (const std::string &channel, byte inByte, bool blocking=true) |
size_t | ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true) |
size_t | ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true) |
size_t | ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
size_t | 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) |
size_t | ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true) |
virtual byte * | ChannelCreatePutSpace (const std::string &channel, size_t &size) |
virtual size_t | ChannelPut2 (const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking) |
virtual size_t | ChannelPutModifiable2 (const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking) |
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 Member Functions | |
static unsigned int | PortNameToNumber (const char *name, const char *protocol="tcp") |
look up the port number given its name, returns 0 if not found | |
static void | StartSockets () |
start Windows Sockets 2 | |
static void | ShutdownSockets () |
calls WSACleanup for Windows Sockets | |
static int | GetLastError () |
returns errno or WSAGetLastError | |
static void | SetLastError (int errorCode) |
sets errno or calls WSASetLastError | |
Static Public Attributes | |
static const std::string | NULL_CHANNEL |
Protected Member Functions | |
lword | DoFlush (unsigned long maxTime, size_t targetSize) |
const NetworkSender & | GetSender () const |
bool | BlockedBySpeedLimit () const |
virtual void | SocketChanged () |
Static Protected Member Functions | |
static int | DecrementPropagation (int propagation) |
Protected Attributes | |
socket_t | m_s |
bool | m_own |
unsigned int NetworkSink::GetMaxWaitObjectCount | ( | ) | const [inherited] |
GetWaitObjects() must be called despite the 0 return from GetMaxWaitObjectCount(); the 0 is because the ScheduleEvent() method is used instead of adding a wait object
Reimplemented from LimitedBandwidth.
Definition at line 401 of file network.cpp.
References Waitable::GetMaxWaitObjectCount(), LimitedBandwidth::GetMaxWaitObjectCount(), and NetworkSink::GetSender().
size_t NetworkSink::Put2 | ( | const byte * | inString, | |
size_t | length, | |||
int | messageEnd, | |||
bool | blocking | |||
) | [virtual, inherited] |
input multiple bytes for blocking or non-blocking processing
messageEnd | means how many filters to signal MessageEnd to, including this one |
Implements BufferedTransformation.
Definition at line 418 of file network.cpp.
References ByteQueue::CurrentSize(), INFINITE_TIME, Exception::OTHER_ERROR, BufferedTransformation::Put(), and NonblockingSink::TimedFlush().
lword NonblockingSink::TimedFlush | ( | unsigned long | maxTime, | |
size_t | targetSize = 0 | |||
) | [inherited] |
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) {}
Definition at line 162 of file network.cpp.
References LimitedBandwidth::ComputeCurrentTransceiveLimit(), TimerBase::ElapsedTime(), LimitedBandwidth::GetMaxBytesPerSecond(), LimitedBandwidth::GetWaitObjects(), INFINITE_TIME, TimerBase::MILLISECONDS, LimitedBandwidth::NoteTransceive(), TimerBase::StartTimer(), LimitedBandwidth::TimeToNextTransceive(), and WaitObjectContainer::Wait().
Referenced by NonblockingSink::IsolatedFlush(), and NetworkSink::Put2().
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 735 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 754 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 772 of file cryptlib.h.
Referenced by BufferedTransformation::ChannelPutModifiable2(), NetworkSource::DoPump(), and Filter::OutputModifiable().
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 void BufferedTransformation::SetAutoSignalPropagation | ( | int | propagation | ) | [inline, virtual, inherited] |
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 812 of file cryptlib.h.
lword BufferedTransformation::MaxRetrievable | ( | ) | const [virtual, inherited] |
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, and ByteQueue::Walker.
Definition at line 279 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().
bool BufferedTransformation::GetNextMessage | ( | ) | [virtual, inherited] |
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 368 of file cryptlib.cpp.
References BufferedTransformation::AnyMessages(), BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetNextMessage().
Referenced by BufferedTransformation::GetNextMessage(), and BufferedTransformation::TransferMessagesTo2().
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 962 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().