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

Step that lists the files of the server whose names begin with a prefix. More...

#include <filelisttask.h>

Inheritance diagram for FileListTask:
Collaboration diagram for FileListTask:

Public Member Functions

 ~FileListTask () override=default
 Destroy the object.
 FileListTask (String *pPrefix, std::list< String > *pFiles)
 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 rtMediusFileResponse *pResponse)
 Add a file whose name begins with the prefix, and finish the step the response is tagged with after the last file.
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
 Clear the names and send the request.
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.

Protected Attributes

String * mPrefix
std::list< String > * mFiles
int mPage
int mReceived
int mPageDone

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 lists the files of the server whose names begin with a prefix.

The RTTI includes the name and records NetTask as the base. The vtable is at 0x003d5068 and the object is 0x14 bytes. The server sends one file per response. The step fails with RepoRemixStatusMsg::kStatusFailed when the request cannot be sent. The European release requests the files by pages of 50, and its object is 0x20 bytes.

Constructor & Destructor Documentation

◆ ~FileListTask()

FileListTask::~FileListTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0039c9e0
Ghidra address:
PAL: 0x0040b690

◆ FileListTask()

FileListTask::FileListTask ( String * pPrefix,
std::list< String > * pFiles )
inline

Construct a step.

Inline.

Parameters
pPrefixThe prefix.
pFilesReceives the names of the files.

Member Function Documentation

◆ OnResponse()

void FileListTask::OnResponse ( int nConnection,
int nType,
int nSize,
const rtMediusFileResponse * pResponse )
static

Add a file whose name begins with the prefix, and finish the step the response is tagged with after the last file.

The name is inferred.

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

◆ OnStart()

void FileListTask::OnStart ( )
overrideprotectedvirtual

Clear the names and send the request.

Ghidra address:
NTSC-U/C: 0x00267018
Ghidra address:
PAL: 0x00270b40

Reimplemented from Task.

Member Data Documentation

◆ mPrefix

String* FileListTask::mPrefix
protected

The prefix.

◆ mFiles

std::list<String>* FileListTask::mFiles
protected

Receives the names of the files.

◆ mPage

int FileListTask::mPage
protected

The page RequestPage() requests, from 0.

◆ mReceived

int FileListTask::mReceived
protected

The files of the page received so far.

◆ mPageDone

int FileListTask::mPageDone
protected

Non-zero once the last file of the page arrives.


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