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

Packet the host sends a console it turns away. More...

#include <joinfailedpkt.h>

Inheritance diagram for JoinFailedPkt:
Collaboration diagram for JoinFailedPkt:

Public Member Functions

 ~JoinFailedPkt () override=default
 Destroy the object.
 JoinFailedPkt ()=default
 Construct a packet with mReason left unset.
 JoinFailedPkt (int nReceiver, int nReason)
 Construct a packet for one peer, ordered and guaranteed.
void * operator new (size_t nSize)
 Allocate a packet, billed to the class name.
void operator delete (void *pBlock)
 Release a packet.
Message * Clone () override
 Produce a heap copy of this packet.
int Type () override
 Report this packet's registered identity.
const char * GetName () const override
 Report this packet's class name.
void PrintExtra (PrnStream &stream) const override
 Write the reason alone, without the sender and the receiver.
void saveGuts (BinStream &stream) const override
 Write the reason as four bytes.
void restoreGuts (BinStream &stream) override
 Read the reason as one signed byte, although saveGuts() writes four.
int GetReason () const
Public Member Functions inherited from InternalPacket
int Route () override
 Report that a received packet goes to the online session.
Public Member Functions inherited from Packet
void PrintExtra (PrnStream &stream) const override
 Write the sender and the receiver that are set, as from: and to:.
unsigned char GetFlags () const
int GetReceiver () const
int GetSender () const
void SetSender (int nSender)
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Static Public Member Functions

static Message * New ()
 Produce a default-constructed packet on the heap.
Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Additional Inherited Members

Public Types inherited from Packet
enum  RouteFlag { kRouteTransport = 1 , kRouteLaunchpad = 2 }
 Bits of Route(). More...
Static Public Attributes inherited from Packet
static constexpr int kUnset = -2
 Value of mSender and mReceiver that marks the member as unset.
static constexpr int kAllPeers = -1
 Value of mReceiver that addresses every peer.
static constexpr unsigned char kFlagOrdered = 1
 Bit of mFlags that LaunchpadRT::Send() turns into the second delivery bit of the session library.
static constexpr unsigned char kFlagGuaranteed = 2
 Bit of mFlags that NetTransport::Send() turns into its guaranteed delivery bit.
Protected Member Functions inherited from InternalPacket
 InternalPacket (unsigned char nFlags=0, int nReceiver=kUnset)
 Construct a packet from an unset sender.
Protected Member Functions inherited from Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet the host sends a console it turns away.

The RTTI records the class as deriving from InternalPacket. The members Clone(), Type(), and GetName() are inline. The member names are inferred.

Constructor & Destructor Documentation

◆ ~JoinFailedPkt()

JoinFailedPkt::~JoinFailedPkt ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003a0448
Ghidra address:
PAL: 0x0040f128

◆ JoinFailedPkt() [1/2]

JoinFailedPkt::JoinFailedPkt ( )
default

Construct a packet with mReason left unset.

Inline. New() expands it.

◆ JoinFailedPkt() [2/2]

JoinFailedPkt::JoinFailedPkt ( int nReceiver,
int nReason )
inline

Construct a packet for one peer, ordered and guaranteed.

Inline.

Parameters
nReceiverThe peer the packet is for.
nReasonWhy the console was turned away, a LaunchpadAbortedMsg::Reason.

Member Function Documentation

◆ New()

Message * JoinFailedPkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x002674f0
Ghidra address:
PAL: 0x002711c8

◆ operator new()

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

Allocate a packet, billed to the class name.

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

◆ operator delete()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * JoinFailedPkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int JoinFailedPkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nJoinFailedPktType.

Implements Message.

◆ GetName()

const char * JoinFailedPkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal JoinFailedPkt.

Implements Message.

◆ PrintExtra()

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

Write the reason alone, without the sender and the receiver.

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

Reimplemented from Message.

◆ saveGuts()

void JoinFailedPkt::saveGuts ( BinStream & stream) const
overridevirtual

Write the reason as four bytes.

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

Reimplemented from Message.

◆ restoreGuts()

void JoinFailedPkt::restoreGuts ( BinStream & stream)
overridevirtual

Read the reason as one signed byte, although saveGuts() writes four.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x00269410
Ghidra address:
PAL: 0x00272ff8

Reimplemented from Message.

◆ GetReason()

int JoinFailedPkt::GetReason ( ) const
inline
Returns
Why the console was turned away, a LaunchpadAbortedMsg::Reason.

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