Crypto++  6.0
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
WindowsPipeReceiver Class Reference

Pipe-based implementation of NetworkReceiver. More...

+ Inheritance diagram for WindowsPipeReceiver:

Public Member Functions

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
HANDLE GetHandle () const
unsigned int GetMaxWaitObjectCount () const
 Maximum number of wait objects that this object can return. More...
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects. More...
- Public Member Functions inherited from NetworkReceiver
virtual bool MustWaitToReceive ()
- Public Member Functions inherited from Waitable
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object. More...

Detailed Description

Pipe-based implementation of NetworkReceiver.

Definition at line 63 of file winpipes.h.

Member Function Documentation

◆ GetMaxWaitObjectCount()

unsigned int WindowsPipeReceiver::GetMaxWaitObjectCount ( ) const

Maximum number of wait objects that this object can return.

the maximum number of wait objects

Implements Waitable.

Definition at line 74 of file winpipes.h.

◆ GetWaitObjects()

void WindowsPipeReceiver::GetWaitObjects ( WaitObjectContainer container,
CallStack const &  callStack 

Retrieves waitable objects.

containerthe wait container to receive the references to the objects.
callStackCallStack() 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 130 of file winpipes.cpp.

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