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

Step that connects the host to a game server. More...

#include <mgclconnecttask.h>

Inheritance diagram for MGCLConnectTask:
Collaboration diagram for MGCLConnectTask:

Public Types

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

Public Member Functions

 ~MGCLConnectTask () override=default
 Destroy the object.
 MGCLConnectTask (int nServer)
 Construct a step for a server.
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 OnConnect (int nConnection, int nStatus)
 Receive the result of the connection and finish sTask.
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.

Static Public Attributes

static MGCLConnectTask * sTask
 The step that waits for OnConnect(), or null.
static int sConnecting
 Non-zero while a connection is under way.
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.

Protected Member Functions

void OnStart () override
 Start connecting to the server.
void OnStop () override
 Clear sTask.
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.

Detailed Description

Step that connects the host to a game server.

The RTTI includes the name and records NetTask as the base. The vtable is at 0x003d4c98, and the object is 0x10 bytes. The step fails with LaunchpadAbortedMsg::kReasonServer.

Member Enumeration Documentation

◆ Server

Values of mServer.

Enumerator
kServerGame 

The game server HostpadRT::mServerInfo describes.

kServerLobby 

The server of the lobby configuration.

Constructor & Destructor Documentation

◆ ~MGCLConnectTask()

MGCLConnectTask::~MGCLConnectTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00399da8
Ghidra address:
PAL: 0x00408630

◆ MGCLConnectTask()

MGCLConnectTask::MGCLConnectTask ( int nServer)
inlineexplicit

Construct a step for a server.

Inline.

Parameters
nServerOne of Server.

Member Function Documentation

◆ OnConnect()

void MGCLConnectTask::OnConnect ( int nConnection,
int nStatus )
static

Receive the result of the connection and finish sTask.

The name is inferred.

Parameters
nConnectionThe connection.
nStatus0 for success, otherwise an error.
Ghidra address:
NTSC-U/C: 0x0025b3d8
Ghidra address:
PAL: 0x00264428

◆ OnStart()

void MGCLConnectTask::OnStart ( )
overrideprotectedvirtual

Start connecting to the server.

Ghidra address:
NTSC-U/C: 0x0025b1e0
Ghidra address:
PAL: 0x00264230

Reimplemented from Task.

◆ OnStop()

void MGCLConnectTask::OnStop ( )
overrideprotectedvirtual

Clear sTask.

Ghidra address:
NTSC-U/C: 0x0025b3c8
Ghidra address:
PAL: 0x00264418

Reimplemented from Task.

Member Data Documentation

◆ sTask

MGCLConnectTask* MGCLConnectTask::sTask
static

The step that waits for OnConnect(), or null.

Ghidra address:
NTSC-U/C: 0x003b0ad8
Ghidra address:
PAL: 0x0042f9a4

◆ sConnecting

int MGCLConnectTask::sConnecting
static

Non-zero while a connection is under way.

Ghidra address:
NTSC-U/C: 0x003b0adc
Ghidra address:
PAL: 0x0042f9a8

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