Class used by Obey and Kick handlers to indicate rescheduling requirements.
- Examples:
- dramahello.cpp.
#include "request.hh"
Specify a request using a RequestCode and completion status.
Not normally used with code=Wait, since that requires a delay.
If the status is NOT ok, then the action will complete and the only requests of note are End (end action) or Exit (Exit task), or KickFailed. Others will be treated as End. KickFailed is only valid for Kick events, in which case it indicates the Kick has failed but the Action continues.
- Parameters
-
status | The status to be associated with the action. |
code | The request code. Defaults to End. |
drama::Request::Request |
( |
RequestCode |
code, |
|
|
double |
delay = 0 |
|
) |
| |
|
inline |
Specify a request using a RequestCode and delay.
- Parameters
-
code | The request code. |
delay | The delay before the action reschedules, if the request code indicates the action will reschedule. Defaults to zero meaning no timed delay (which is an error if the code is Wait.) |
double drama::Request::GetDelay |
( |
| ) |
const |
|
inline |
StatusType drama::Request::GetStatus |
( |
| ) |
const |
|
inline |
The documentation for this class was generated from the following file: