A request to the online library, as the NetTask steps that run one after another.
More...
#include <netmultitask.h>
|
| | ~NetMultiTask () override=default |
| | Destroy the object.
|
| | NetMultiTask () |
| | Construct a request with no steps.
|
| void | Add (NetTask *pTask) |
| | Append a step and make the request its parent.
|
| void | Start (MsgSink *pSink) |
| | Start the request.
|
| void | Notify (Message *pMsg) |
| | Pass a message to mSink, when there is one.
|
| MsgSink * | GetSink () const |
| int | GetResult () const |
| void | SetResult (int nResult) |
| | Record the result of a failed step.
|
| | ~SerialTasks () override |
| | Release the list and every task in it.
|
| void | Add (Task *pTask) |
| | Append a task, which the list then manages.
|
| | Task () |
| | Construct an idle task.
|
| virtual | ~Task () |
| | Release the task.
|
| int | Poll () |
| | Report the state after giving a running task one poll.
|
| void | Start () |
| | Enter the running state and call OnStart(), unless the task is already running.
|
| void | Stop () |
| | Call OnStop() when the task is running, and return to the idle state.
|
| void | Finish (bool bSucceeded) |
| | End the task from outside its poll, and call OnStop() when it was running.
|
| int | GetState () const |
| | Report mState.
|
|
| enum | State { kStateIdle = 0
, kStateRunning = 1
, kStateDone = 2
, kStateFailed = 3
} |
| | Values of mState. More...
|
| void | OnStart () override |
| | Start the first task, or finish with success when the list is empty.
|
| void | OnStop () override |
| | Stop the task that runs now.
|
| void | OnPoll () override |
| | Poll the task that runs now, start the next one after it is done, and finish after the last one or after a failure.
|
| const std::vector< std::unique_ptr< Task > > & | GetTasks () const |
A request to the online library, as the NetTask steps that run one after another.
The RTTI includes the name and records SerialTasks as the base. The vtable is at 0x003d4820. The constructor has no out-of-line copy. It clears mSink and mResult.
◆ ~NetMultiTask()
| NetMultiTask::~NetMultiTask |
( |
| ) |
|
|
overridedefault |
Destroy the object.
- Ghidra address:
- NTSC-U/C: 0x00398c30
- Ghidra address:
- PAL: 0x004074b8
◆ NetMultiTask()
| NetMultiTask::NetMultiTask |
( |
| ) |
|
|
inline |
Construct a request with no steps.
The constructor has no out-of-line copy.
◆ Add()
| void NetMultiTask::Add |
( |
NetTask * | pTask | ) |
|
Append a step and make the request its parent.
- Parameters
-
- Ghidra address:
- NTSC-U/C: 0x0026a508
- Ghidra address:
- PAL: 0x00274098
◆ Start()
| void NetMultiTask::Start |
( |
MsgSink * | pSink | ) |
|
Start the request.
- Parameters
-
| pSink | The receiver of the messages of the request, or null. |
- Ghidra address:
- NTSC-U/C: 0x0026a530
- Ghidra address:
- PAL: 0x002740c0
◆ Notify()
| void NetMultiTask::Notify |
( |
Message * | pMsg | ) |
|
Pass a message to mSink, when there is one.
- Parameters
-
- Ghidra address:
- NTSC-U/C: 0x0026a550
- Ghidra address:
- PAL: 0x002740e0
◆ GetSink()
| MsgSink * NetMultiTask::GetSink |
( |
| ) |
const |
|
inline |
- Returns
- The receiver of the messages of the request, or null.
◆ GetResult()
| int NetMultiTask::GetResult |
( |
| ) |
const |
|
inline |
- Returns
- The result a failed step recorded, or 0.
◆ SetResult()
| void NetMultiTask::SetResult |
( |
int | nResult | ) |
|
|
inline |
Record the result of a failed step.
- Parameters
-
The documentation for this class was generated from the following file: