#include <socketft.h>
Inheritance diagram for SocketSink:
Definition at line 200 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 |
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 | |
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) |
unsigned int | Send (const byte *buf, unsigned int bufLen, int flags=0) |
unsigned int | Receive (byte *buf, unsigned int 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 |
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 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 | |
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 transferred 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 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 | |
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 |
virtual void | SocketChanged () |
Static Protected Member Functions | |
static int | DecrementPropagation (int propagation) |
Protected Attributes | |
socket_t | m_s |
bool | m_own |
|
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(), NetworkSink::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(), NetworkSink::ComputeCurrentSpeed(), ByteQueue::CurrentSize(), TimerBase::ElapsedTime(), NetworkSender::GetSendResult(), INFINITE_TIME, NetworkSender::MustWaitForResult(), NetworkSender::MustWaitToSend(), NetworkSender::Send(), BufferedTransformation::Skip(), ByteQueue::Spy(), and Waitable::Wait(). Referenced by NetworkSink::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 711 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 730 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 748 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(), and BufferedTransformation::ChannelMessageSeriesEnd(). |
|
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 788 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 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 934 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(). |