|
wavelength 1.0.0
|
Unit of work an owner starts, polls until it reports that it is done, and stops. More...
#include <task.h>

Public Types | |
| enum | State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 } |
| Values of mState. More... | |
Public Member Functions | |
| 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 | |
| virtual void | OnStart () |
| Begin the work. | |
| virtual void | OnStop () |
| Abandon the work. | |
| virtual void | OnPoll () |
| Advance the work, and set mState to kStateDone when it finishes. | |
Unit of work an owner starts, polls until it reports that it is done, and stops.
The RTTI includes the class name, and the class has no base. One data word, the state, precedes the vptr.
| enum Task::State |
|
inline |
Construct an idle task.
The constructor has no out-of-line copy.
|
virtual |
Release the task.
| int Task::Poll | ( | ) |
Report the state after giving a running task one poll.
| void Task::Start | ( | ) |
Enter the running state and call OnStart(), unless the task is already running.
| void Task::Stop | ( | ) |
Call OnStop() when the task is running, and return to the idle state.
| void Task::Finish | ( | bool | bSucceeded | ) |
End the task from outside its poll, and call OnStop() when it was running.
The name is inferred.
| bSucceeded | Enter kStateDone rather than kStateFailed. |
| int Task::GetState | ( | ) | const |
Report mState.
|
inlineprotectedvirtual |
Begin the work.
Start() calls this member.
Reimplemented in AccountDeleteTask, AccountGetIDTask, AccountLoginTask, AccountRegistrationTask, AccountUpdatePasswordTask, AccountUpdateStatsTask, AllocateBufferTask, AnonymousLoginTask, BanPlayerTask, ChannelInfoTask, CheckInetTask, ClearGameListFilterTask, ClockSyncTask, CloseMGCLTask, CloseRTTask, CreateChannelTask, DoDNSTask, FileCloseTask, FileCreateTask, FileDeleteTask, FileDownloadTask, FileGetAttributesTask, FileListTask, FileUpdateAttributesTask, FileUploadTask, FindPlayerTask, FinishUpdateGameParamsTask, GetAnnouncementsTask, GetChannelsTask, GetGamePlayersTask, GetGamesTask, GetLobbyPlayersTask, GetPolicyTask, InitMGCLTask, InitRTTask, JoinChannelTask, KillLaunchpadTask, LadderListTask, LadderPosition2Task, LadderPositionFastTask, LadderPositionTask, LoadGameTask, MCCloseTask, MCCreateSaveDirTask, MCDeleteSavedRemixTask, MCDeleteTask, MCFindRemixTask, MCFormatTask, MCGetAllRemixInfosTask, MCGetDirTask, MCGetInfoTask, MCGetRemixNamesTask, MCLoadFreqFilesTask, MCMkDirTask, MCNetConfigTask, MCOpenCurrRemixTask, MCOpenTask, MCReadTask, MCSeekTask, MCUnformatTask, MCWriteTask, MediusConnectTask, MediusJoinGameTask, MediusSendPlayerReportTask, MediusSendWorldReportTask, MGCLAuthenticationTask, MGCLConnectTask, MGCLCreateGameTask, MGCLSendServerReportTask, MGCLSessionBeginTask, MGCLSessionEndTask, NetConnectTask, NetDisconnectTask, NetHostTask, PlayerInfoTask, ScriptTask, SerialTasks, SessionBeginTask, SessionEndTask, SetGameListFilterTask, SetLocParamsTask, SetupLocalPlayerTask, StreamTask, TextFilterTask, UpdateClientStateTask, VersionServerTask, WaitForTaskTask, WaitInteractiveRemixTask, WaitInteractiveTask, and WaitTimeTask.
|
inlineprotectedvirtual |
Abandon the work.
Stop() calls this member for a running task.
Reimplemented in DoDNSTask, InitRTTask, MCCheckRemixSpaceNeededTask, MCCheckSaveSpaceNeededTask, MCLoadFileTask, MediusConnectTask, MemcardSerialTask, MGCLConnectTask, NetConnectTask, NetHostTask, NetTask, SerialTasks, StreamTask, WaitInteractiveRemixTask, and WaitInteractiveTask.
|
inlineprotectedvirtual |
Advance the work, and set mState to kStateDone when it finishes.
Reimplemented in ClockSyncTask, FileDownloadTask, FileUploadTask, LadderListTask, MCCreateSaveDirTask, MCDeleteSavedRemixTask, MCFindRemixTask, MCGetAllRemixInfosTask, MCGetRemixNamesTask, MCLoadFreqFilesTask, MCOpenCurrRemixTask, MediusDisconnectTask, MemcardTask, MGCLDisconnectTask, MGCLSessionEndTask, NetConnectTask, SerialTasks, SessionEndTask, StreamTask, WaitForKeyTask, WaitForShareDoneTask, WaitForWelcomeTask, WaitInteractiveRemixTask, WaitInteractiveTask, and WaitTimeTask.