#include <socketft.h>
Inheritance diagram for SocketSink:
Definition at line 200 of file socketft.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 transfered 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 | |
SocketSink (socket_t s=INVALID_SOCKET, unsigned int maxBufferSize=0, bool autoFlush=false) | |
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 | 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 | |
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 |
Static Public Member Functions | |
unsigned int | PortNameToNumber (const char *name, const char *protocol="tcp") |
look up the port number given its name, returns 0 if not found | |
void | StartSockets () |
start Windows Sockets 2 | |
void | ShutdownSockets () |
calls WSACleanup for Windows Sockets | |
int | GetLastError () |
returns errno or WSAGetLastError | |
void | SetLastError (int errorCode) |
sets errno or calls WSASetLastError | |
Static Public Attributes | |
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 | |
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 129 of file network.cpp. References ByteQueue::CurrentSize(), ByteQueue::FinalizeLazyPut(), INFINITE_TIME, ByteQueue::LazyPut(), NetworkSink::Put2(), NetworkSender::SendEof(), NetworkSink::TimedFlush(), and ByteQueue::UndoLazyPut(). Referenced by NetworkSink::Put2(). |
|
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(), NetworkSink::TimedFlush(), and Waitable::Wait(). Referenced by NetworkSink::Put2(), and NetworkSink::TimedFlush(). |
|
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. |
|
flush buffered input and/or output
Reimplemented in Filter. Definition at line 166 of file cryptlib.cpp. References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::Flush(). Referenced by BufferedTransformation::Flush(). |
|
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(), and BufferedTransformation::MessageSeriesEnd(). Referenced by BufferedTransformation::MessageSeriesEnd(). |
|
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(). |
|
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(), WaitObjectContainer::Wait(), and Waitable::Wait(). Referenced by NetworkSource::GeneralPump2(), NetworkSink::TimedFlush(), and Waitable::Wait(). |