wavelength 1.0.0
Loading...
Searching...
No Matches
WaitForTaskTask Class Reference

Task that waits until a TaskDoneNotifier reports that named work is done. More...

#include <waitfortasktask.h>

Inheritance diagram for WaitForTaskTask:
Collaboration diagram for WaitForTaskTask:

Public Member Functions

 ~WaitForTaskTask () override=default
 Destroy the object.
 WaitForTaskTask (const char *pszName, TaskDoneNotifier *pNotifier)
 Construct a task that waits for the named work.
Public Member Functions inherited from Task
 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.

Protected Member Functions

void OnStart () override
 Arrange for the notifier to report the work to this task.
Protected Member Functions inherited from Task
virtual void OnStop ()
 Abandon the work.
virtual void OnPoll ()
 Advance the work, and set mState to kStateDone when it finishes.

Additional Inherited Members

Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...

Detailed Description

Task that waits until a TaskDoneNotifier reports that named work is done.

The RTTI includes the class name and records Task as the base.

Constructor & Destructor Documentation

◆ ~WaitForTaskTask()

WaitForTaskTask::~WaitForTaskTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00344098
Ghidra address:
PAL: 0x003b15d0

◆ WaitForTaskTask()

WaitForTaskTask::WaitForTaskTask ( const char * pszName,
TaskDoneNotifier * pNotifier )

Construct a task that waits for the named work.

The task records the name pointer and does not copy the text.

Parameters
pszNameThe name of the work.
pNotifierThe notifier that reports the work.
Ghidra address:
NTSC-U/C: 0x001418a0
Ghidra address:
PAL: 0x00143240

Member Function Documentation

◆ OnStart()

void WaitForTaskTask::OnStart ( )
overrideprotectedvirtual

Arrange for the notifier to report the work to this task.

Ghidra address:
NTSC-U/C: 0x001418c0
Ghidra address:
PAL: 0x00143260

Reimplemented from Task.


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