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

Result of NetLobby::Connect(). More...

#include <lobbyconnectresultmsg.h>

Inheritance diagram for LobbyConnectResultMsg:
Collaboration diagram for LobbyConnectResultMsg:

Public Types

enum  Result {
  kResultFailed = -100 , kResultLostInternet = -91 , kResultLookupFailed = -90 , kResultSessionFailed = -89 ,
  kResultConnectFailed = -88 , kResultDNASFailed = -60 , kResultSuccess = 0
}
 Values of mResult. More...

Public Member Functions

 LobbyConnectResultMsg (int nResult)
 Construct a result with no locations.
void * operator new (size_t nSize)
 Allocate a message, billed to the class name.
void operator delete (void *pBlock)
 Release a message.
Message * Clone () override
 Produce a heap copy of this message.
int Type () override
 Report this message's registered identity.
const char * GetName () const override
 Report this message's class name.
void PrintExtra (PrnStream &stream) const override
 Write the result, and the locations after a success.
const std::list< LobbyLocation > & GetLocations () const
std::list< LobbyLocation > & GetLocations ()
int GetResult () const
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual void saveGuts (BinStream &stream) const
 Write this message's payload to a stream.
virtual void restoreGuts (BinStream &stream)
 Read this message's payload from a stream.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Additional Inherited Members

Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Detailed Description

Result of NetLobby::Connect().

The RTTI includes the class name and records Message as the base. Only the members its readers here use are declared.

Member Enumeration Documentation

◆ Result

Values of mResult.

Enumerator
kResultFailed 

The network library failed.

kResultLostInternet 

The network connection was lost.

kResultLookupFailed 

The name of the server did not resolve.

kResultSessionFailed 

The lobby session did not begin.

kResultConnectFailed 

The lobby server did not connect.

kResultDNASFailed 

The DNAS authentication failed, in the European release.

kResultSuccess 

The lobby server is connected.

Constructor & Destructor Documentation

◆ LobbyConnectResultMsg()

LobbyConnectResultMsg::LobbyConnectResultMsg ( int nResult)
inlineexplicit

Construct a result with no locations.

Inline.

Parameters
nResultOne of Result, or another negative error.

Member Function Documentation

◆ operator new()

void * LobbyConnectResultMsg::operator new ( size_t nSize)
inline

Allocate a message, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void LobbyConnectResultMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * LobbyConnectResultMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.

Implements Message.

◆ Type()

int LobbyConnectResultMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nLobbyConnectResultMsgType.

Implements Message.

◆ GetName()

const char * LobbyConnectResultMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal LobbyConnectResultMsg.

Implements Message.

◆ PrintExtra()

void LobbyConnectResultMsg::PrintExtra ( PrnStream & stream) const
overridevirtual

Write the result, and the locations after a success.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x00268af8
Ghidra address:
PAL: 0x00272700

Reimplemented from Message.

◆ GetLocations() [1/2]

const std::list< LobbyLocation > & LobbyConnectResultMsg::GetLocations ( ) const
inline
Returns
The locations of the server.

◆ GetLocations() [2/2]

std::list< LobbyLocation > & LobbyConnectResultMsg::GetLocations ( )
inline
Returns
The locations of the server, for filling.

◆ GetResult()

int LobbyConnectResultMsg::GetResult ( ) const
inline
Returns
One of Result, or another negative error.

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