SocketReceiver Class Reference

Inheritance diagram for SocketReceiver:
NetworkReceiver Waitable

List of all members.

Public Member Functions

 SocketReceiver (Socket &s)
bool MustWaitForResult ()
bool Receive (byte *buf, size_t bufLen)
 receive data from network source, returns whether result is immediately available
unsigned int GetReceiveResult ()
bool EofReceived () const
unsigned int GetMaxWaitObjectCount () const
 Maximum number of wait objects that this object can return.
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects.
virtual bool MustWaitToReceive ()
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 wait on this object

Detailed Description

Definition at line 125 of file socketft.h.


Member Function Documentation

void SocketReceiver::GetWaitObjects ( WaitObjectContainer container,
CallStack const &  callStack 
) [virtual]

Retrieves waitable objects.

Parameters:
container the wait container to receive the references to the objects.
callStack CallStack object used to select waitable objects

GetWaitObjects is usually called in one of two ways. First, it can be called like something.GetWaitObjects(c, CallStack("my func after X", 0));. Second, if in an outer GetWaitObjects() method that itself takes a callStack parameter, it can be called like innerThing.GetWaitObjects(c, CallStack("MyClass::GetWaitObjects at X", &callStack));.

Implements Waitable.

Definition at line 372 of file socketft.cpp.

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 426 of file wait.cpp.

References Waitable::GetWaitObjects().


The documentation for this class was generated from the following files:

Generated on 24 Mar 2016 for Crypto++ by  doxygen 1.6.1