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

Step that deletes a file of the server. More...

#include <filedeletetask.h>

Inheritance diagram for FileDeleteTask:
Collaboration diagram for FileDeleteTask:

Public Member Functions

 ~FileDeleteTask () override=default
 Destroy the object.
 FileDeleteTask (String *pName, int *pnEnabled)
 Construct a step.
Public Member Functions inherited from NetTask
 NetTask ()
 Construct a task outside any NetMultiTask.
void Finish (bool bSucceeded, int nResult)
 End the task, and record a failure in the result of the NetMultiTask that runs it.
NetMultiTask * GetParent () const
void SetParent (NetMultiTask *pParent)
 Set the NetMultiTask that runs the task.
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.

Static Public Member Functions

static void OnResponse (int nConnection, int nType, int nSize, const rtMediusFileDeleteResponse *pResponse)
 Finish the step the response is tagged with.
Static Public Member Functions inherited from NetTask
static void MakeTag (NetTask *pTask, char *pszTag)
 Create the next tag of a task and copy its text.
static void RemoveTag (NetTask *pTask)
 Remove the first tag of a task.
static NetTask * FindTag (const char *pszTag)
 Find the task of a tag.

Protected Member Functions

void OnStart () override
 Send the request, or finish when the deletion is not enabled.
Protected Member Functions inherited from NetTask
void OnStop () override
 Remove the tag of the task.
Protected Member Functions inherited from Task
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...
Static Public Attributes inherited from NetTask
static std::list< NetTaskTag > sTags
 The tags MakeTag() created and RemoveTag() has not removed.
static int sNextTag
 The number the next tag takes.

Detailed Description

Step that deletes a file of the server.

The RTTI includes the name and records NetTask as the base. The vtable is at 0x003d5038 and the object is 0x14 bytes. The step fails with RepoRemixStatusMsg::kStatusFailed when the request cannot be sent, and otherwise succeeds whatever the server reports.

Constructor & Destructor Documentation

◆ ~FileDeleteTask()

FileDeleteTask::~FileDeleteTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0039ca58
Ghidra address:
PAL: 0x0040b780

◆ FileDeleteTask()

FileDeleteTask::FileDeleteTask ( String * pName,
int * pnEnabled )
inline

Construct a step.

Inline.

Parameters
pNameThe file.
pnEnabledThe word that enables the deletion when non-zero.

Member Function Documentation

◆ OnResponse()

void FileDeleteTask::OnResponse ( int nConnection,
int nType,
int nSize,
const rtMediusFileDeleteResponse * pResponse )
static

Finish the step the response is tagged with.

The name is inferred.

Parameters
nConnectionThe connection.
nTypeThe kind of response.
nSizeThe size of the response.
pResponseThe response.
Ghidra address:
NTSC-U/C: 0x002672f0
Ghidra address:
PAL: 0x00270fc8

◆ OnStart()

void FileDeleteTask::OnStart ( )
overrideprotectedvirtual

Send the request, or finish when the deletion is not enabled.

Ghidra address:
NTSC-U/C: 0x00267238
Ghidra address:
PAL: 0x00270f10

Reimplemented from Task.


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