Interface for objects that can be waited on. More...
#include <cryptlib.h>
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. | |
| bool | Wait (unsigned long milliseconds, CallStack const &callStack) |
| Wait on this object. | |
Detailed Description
Interface for objects that can be waited on.
Definition at line 1602 of file cryptlib.h.
Constructor & Destructor Documentation
◆ ~Waitable()
|
inlinevirtual |
Definition at line 1605 of file cryptlib.h.
Member Function Documentation
◆ GetMaxWaitObjectCount()
|
pure virtual |
Maximum number of wait objects that this object can return.
- Returns
- the maximum number of wait objects
Implemented in BufferedTransformation.
◆ GetWaitObjects()
|
pure 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));.
Implemented in BufferedTransformation.
◆ Wait()
| bool Waitable::Wait | ( | unsigned long | milliseconds, |
| CallStack const & | callStack | ||
| ) |
Wait on this object.
- Returns
- true if the wait succeeded, false otherwise
Wait() is the same as creating an empty container, calling GetWaitObjects(), and then calling Wait() on the container.
The documentation for this class was generated from the following file:
- G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/cryptlib.h
