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

Step that connects the lobby client to a lobby server. More...

#include <mediusconnecttask.h>

Inheritance diagram for MediusConnectTask:
Collaboration diagram for MediusConnectTask:

Public Types

enum  Server { kServerLocation = 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

 ~MediusConnectTask () override=default
 Destroy the object.
 MediusConnectTask (int nServer)
 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 OnConnect (int nConnection)
 Take 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 MediusConnectTask * sTask
 The step that waits for OnConnect(), or null.
static int sConnecting
 Non-zero while a connection is being made.
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.
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 lobby client to a lobby server.

The RTTI includes the name and records NetTask as the base. The vtable is at 0x003d5788 and the object is 0x10 bytes. The step sets LobbyRT::mMediusConnected, and it fails with LobbyConnectResultMsg::kResultConnectFailed.

Member Enumeration Documentation

◆ Server

Values of mServer.

Enumerator
kServerLocation 

The server LobbyRT::mLobbyInfo identifies.

kServerLobby 

The server server.cfg identifies.

Constructor & Destructor Documentation

◆ ~MediusConnectTask()

MediusConnectTask::~MediusConnectTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0039b918
Ghidra address:
PAL: 0x0040a560

◆ MediusConnectTask()

MediusConnectTask::MediusConnectTask ( int nServer)
inlineexplicit

Construct a step.

Inline.

Parameters
nServerOne of Server.

Member Function Documentation

◆ OnConnect()

void MediusConnectTask::OnConnect ( int nConnection)
static

Take the result of the connection and finish sTask.

The name is inferred.

Parameters
nConnectionThe connection, or -1 when the connection failed.
Ghidra address:
NTSC-U/C: 0x00263250
Ghidra address:
PAL: 0x0026c4a8

◆ OnStart()

void MediusConnectTask::OnStart ( )
overrideprotectedvirtual

Start connecting.

Ghidra address:
NTSC-U/C: 0x00262fa0
Ghidra address:
PAL: 0x0026c0f8

Reimplemented from Task.

◆ OnStop()

void MediusConnectTask::OnStop ( )
overrideprotectedvirtual

Clear sTask.

Ghidra address:
NTSC-U/C: 0x00263240
Ghidra address:
PAL: 0x0026c400

Reimplemented from Task.

Member Data Documentation

◆ sTask

MediusConnectTask* MediusConnectTask::sTask
static

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

Ghidra address:
NTSC-U/C: 0x003b0afc
Ghidra address:
PAL: 0x0042f9c8

◆ sConnecting

int MediusConnectTask::sConnecting
static

Non-zero while a connection is being made.

Ghidra address:
NTSC-U/C: 0x003b0b00
Ghidra address:
PAL: 0x0042f9cc

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