Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

SocketSource Class Reference

#include <socketft.h>

Inheritance diagram for SocketSource:

NetworkSource Socket NonblockingSource AutoSignaling< Source > Source InputRejecting< Filter > Filter BufferedTransformation Algorithm Waitable Clonable List of all members.

Detailed Description

socket-based implementation of NetworkSource

Definition at line 184 of file socketft.h.

Public Member Functions

 SocketSource (socket_t s=INVALID_SOCKET, bool pumpAll=false, BufferedTransformation *attachment=NULL)
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 GeneralPump2 (unsigned long &byteCount, bool blockingOutput=true, unsigned long maxTime=INFINITE_TIME, bool checkDelimiter=false, byte delimiter='\n')
 pump up to maxSize bytes using at most maxTime milliseconds
bool SourceExhausted () const
void SetAutoSignalPropagation (int propagation)
 set propagation of automatically generated and transferred signals
int GetAutoSignalPropagation () const
unsigned long Pump (unsigned long pumpMax=ULONG_MAX)
unsigned int PumpMessages (unsigned int count=UINT_MAX)
void PumpAll ()
virtual unsigned int PumpAll2 (bool blocking=true)
unsigned int Put2 (const byte *begin, unsigned int length, int messageEnd, bool blocking)
 input multiple bytes for blocking or non-blocking processing
bool IsolatedFlush (bool, bool)
bool IsolatedMessageSeriesEnd (bool)
unsigned int ChannelPut2 (const std::string &channel, const byte *begin, unsigned int length, int messageEnd, bool blocking)
bool ChannelMessageSeriesEnd (const std::string &, int, bool)
bool Attachable ()
 returns whether this object allows attachment
BufferedTransformationAttachedTransformation ()
 returns the object immediately attached to this object or NULL for no attachment
const BufferedTransformationAttachedTransformation () const
void Detach (BufferedTransformation *newAttachment=NULL)
 delete the current attachment chain and replace it with newAttachment
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
void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 initialize or reinitialize this object
bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 flush buffered input and/or output
bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 mark end of a series of messages
BufferedTransformationRef ()
 return a reference to this object
virtual std::string AlgorithmName () const
 returns name of this algorithm, not universally implemented yet
virtual ClonableClone () 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 NetworkReceiverGetReceiver () const
void SourceInitialize (bool pumpAll, const NameValuePairs &parameters)
virtual BufferedTransformationNewDefaultAttachment () const
void Insert (Filter *nextFilter)
virtual bool ShouldPropagateMessageEnd () const
virtual bool ShouldPropagateMessageSeriesEnd () const
void PropagateInitialize (const NameValuePairs &parameters, int propagation)
unsigned int Output (int outputSite, const byte *inString, unsigned int length, int messageEnd, bool blocking, const std::string &channel=NULL_CHANNEL)
unsigned int OutputModifiable (int outputSite, byte *inString, unsigned int length, int messageEnd, bool blocking, const std::string &channel=NULL_CHANNEL)
bool OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)
bool OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)
bool OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)
virtual void SocketChanged ()

Static Protected Member Functions

int DecrementPropagation (int propagation)

Protected Attributes

unsigned int m_inputPosition
int m_continueAt
socket_t m_s
bool m_own

Member Function Documentation

unsigned int NetworkSource::GeneralPump2 unsigned long &  byteCount,
bool  blockingOutput = true,
unsigned long  maxTime = INFINITE_TIME,
bool  checkDelimiter = false,
byte  delimiter = '\n'
[virtual, inherited]

pump up to maxSize bytes using at most maxTime milliseconds

If checkDelimiter is true, pump up to delimiter, which itself is not extracted or pumped.

Implements NonblockingSource.

Definition at line 57 of file network.cpp.

References Filter::AttachedTransformation(), TimerBase::ElapsedTime(), NetworkReceiver::EofReceived(), NetworkReceiver::GetReceiveResult(), INFINITE_TIME, NetworkReceiver::MustWaitForResult(), NetworkReceiver::MustWaitToReceive(), NetworkReceiver::Receive(), SecBlock< T, A >::size(), and Waitable::Wait().

void AutoSignaling< Source >::SetAutoSignalPropagation int  propagation  )  [inline, virtual, inherited]

Reimplemented from BufferedTransformation.

Definition at line 168 of file simple.h.

unsigned int InputRejecting< Filter >::Put2 const byte *  begin,
unsigned int  length,
int  messageEnd,
bool  blocking
[inline, virtual, inherited]

Implements BufferedTransformation.

Definition at line 99 of file simple.h.

bool Filter::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 from BufferedTransformation.

Definition at line 19 of file filters.h.

bool Filter::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
Hard flushes must be used with care. It means try to process and output everything, even if there may not be enough data to complete the action. For example, hard flushing a HexDecoder would cause an error if you do it after inputing an odd number of hex encoded characters. For some types of filters, for example ZlibDecompressor, hard flushes can only be done at "synchronization points". These synchronization points are positions in the data stream that are created by hard flushes on the corresponding reverse filters, in this example ZlibCompressor. This is useful when zlib compressed data is moved across a network in packets and compression state is preserved across packets, as in the ssh2 protocol.

Reimplemented from BufferedTransformation.

Reimplemented in SecretSharing, and InformationDispersal.

Definition at line 68 of file filters.cpp.

bool Filter::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 from BufferedTransformation.

Definition at line 82 of file filters.cpp.

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 711 of file cryptlib.h.

virtual byte* BufferedTransformation::CreatePutSpace unsigned int &  size  )  [inline, virtual, inherited]

request space which can be written into by the caller, and then used as input to Put()

The purpose of this method is to help avoid doing extra memory allocations.

Reimplemented in MeterFilter, HashFilter, Redirector, ArraySink, ArrayXorSink, and ByteQueue.

Definition at line 730 of file cryptlib.h.

Referenced by ArrayXorSink::CreatePutSpace().

virtual unsigned int BufferedTransformation::PutModifiable2 byte *  inString,
unsigned int  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, and FilterWithBufferedInput.

Definition at line 748 of file cryptlib.h.

unsigned long 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 RandomPool.

Definition at line 247 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::CopyTo().

Referenced by RandomNumberStore::AnyRetrievable(), and Integer::BERDecode().

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 336 of file cryptlib.cpp.

References BufferedTransformation::AnyMessages(), and BufferedTransformation::AttachedTransformation().

bool Waitable::Wait unsigned long  milliseconds  )  [inherited]

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().

The documentation for this class was generated from the following file:
Generated on Wed Jul 21 19:16:10 2004 for Crypto++ by doxygen 1.3.7-20040704