Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
Waitable Class Referenceabstract

Interface for objects that can be waited on. More...

+ Inheritance diagram for Waitable:

Public Member Functions

virtual unsigned int GetMaxWaitObjectCount () const =0
 Maximum number of wait objects that this object can return.
virtual void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)=0
 Retrieves waitable objects. More...
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 wait on this object More...

Detailed Description

Interface for objects that can be waited on.

Definition at line 1165 of file cryptlib.h.

Member Function Documentation

virtual void Waitable::GetWaitObjects ( WaitObjectContainer container,
CallStack const &  callStack 
pure virtual

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

Implemented in BufferedTransformation, Redirector, NetworkSink, and NetworkSource.

Referenced by NetworkSource::GetWaitObjects(), NetworkSink::GetWaitObjects(), and Wait().

bool Waitable::Wait ( unsigned long  milliseconds,
CallStack const &  callStack 

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

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