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

Task that opens a file and records its descriptor in MemcardTask::sFd. More...

#include <mcopentask.h>

Inheritance diagram for MCOpenTask:
Collaboration diagram for MCOpenTask:

Public Member Functions

 ~MCOpenTask () override=default
 Destroy the object.
 MCOpenTask ()
 Construct an idle task.
void Set (int nPort, const char *pszName, int nMode)
 Prepare the task.
void OnOpen (int nResult) override
 Record the descriptor and the outcome, and finish.
Public Member Functions inherited from MemcardTask
 ~MemcardTask () override=default
 Destroy the object.
 MemcardTask ()
 Construct an idle task for the first slot.
void SetPort (int nPort)
 Select the slot the command addresses.
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.
Public Member Functions inherited from MemcardCBHandler
virtual ~MemcardCBHandler ()
 Release the handler.
virtual void OnGetInfo (int nResult)
 Receive the result of MemcardGetInfo().
virtual void OnGetEntSpace (int nResult)
 Receive the free entries of a directory.
virtual void OnClose (int nResult)
 Receive the result of MemcardClose().
virtual void OnRead (int nResult)
 Receive the result of MemcardRead().
virtual void OnWrite (int nResult)
 Receive the result of MemcardWrite().
virtual void OnSeek (int nResult)
 Receive the result of MemcardSeek().
virtual void OnMkdir (int nResult)
 Receive the result of MemcardMkdir().
virtual void OnRename (int nResult)
 Receive the result of a rename.
virtual void OnDelete (int nResult)
 Receive the result of MemcardDelete().
virtual void OnFormat (int nResult)
 Receive the result of MemcardFormat().
virtual void OnUnformat (int nResult)
 Receive the result of MemcardUnformat().
virtual void OnGetDir (int nResult, MemcardDirEntry *pEntries)
 Receive the result of MemcardGetDir().

Protected Member Functions

void OnStart () override
 Issue the command.
Protected Member Functions inherited from MemcardTask
void OnPoll () override
 Advance the memory card command in flight.
Protected Member Functions inherited from Task
virtual void OnStop ()
 Abandon the work.

Additional Inherited Members

Public Types inherited from MemcardTask
enum  Status {
  kStatusOk = 0 , kStatusNoCard = 1 , kStatusFull = 2 , kStatusUnformatted = 3 ,
  kStatusChangedCard = 4 , kStatusExists = 5 , kStatusLimit = 6 , kStatusFormatted = 7 ,
  kStatusNotFound = 8 , kStatusConfigsBad = 9 , kStatusConfigsError = 10
}
 Values of sStatus, the outcome every memory card task and user reports. More...
Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...
Static Public Member Functions inherited from MemcardTask
static void SetStatus (int nResult)
 Record a library result in sResult, and translate the result into sStatus.
Static Public Attributes inherited from MemcardTask
static int sFd
 The file descriptor the last open reported.
static int sResult
 The library result SetStatus() last translated.
static int sStatus
 The outcome of the last command, one of Status.
static MemcardDirEntry * sDirEntries
 The entries the last directory listing reported.
static int sDirCount
 The number of entries the last directory listing reported.
Protected Attributes inherited from MemcardTask
int mPort

Detailed Description

Task that opens a file and records its descriptor in MemcardTask::sFd.

The RTTI records the class as deriving from MemcardTask. The object is 0x28 bytes.

Constructor & Destructor Documentation

◆ ~MCOpenTask()

MCOpenTask::~MCOpenTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003515f8
Ghidra address:
PAL: 0x003be878

◆ MCOpenTask()

MCOpenTask::MCOpenTask ( )
inline

Construct an idle task.

Member Function Documentation

◆ Set()

void MCOpenTask::Set ( int nPort,
const char * pszName,
int nMode )

Prepare the task.

Parameters
nPortThe memory card slot.
pszNameThe file.
nModeThe library's open mode bits.
Ghidra address:
NTSC-U/C: 0x0015d9b8
Ghidra address:
PAL: 0x0015f1d0

◆ OnOpen()

void MCOpenTask::OnOpen ( int nResult)
overridevirtual

Record the descriptor and the outcome, and finish.

Parameters
nResultThe file descriptor, or a negative library error.
Ghidra address:
NTSC-U/C: 0x0015da08
Ghidra address:
PAL: 0x0015f220

Reimplemented from MemcardCBHandler.

◆ OnStart()

void MCOpenTask::OnStart ( )
overrideprotectedvirtual

Issue the command.

The PAL build first records the file in g_MemcardOpenPath.

Ghidra address:
NTSC-U/C: 0x0015da60
Ghidra address:
PAL: 0x0015f278

Reimplemented from Task.


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