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

Packet in which the arbitrating console assigns every player a track. More...

#include <arbiterpacket.h>

Inheritance diagram for ArbiterPacket:
Collaboration diagram for ArbiterPacket:

Classes

class  PlayerData
 One player's assignment. More...

Public Member Functions

 ~ArbiterPacket () override=default
 Destroy the object.
 ArbiterPacket ()
 Construct a packet with no assignments.
 ArbiterPacket (int nVersion)
 Construct an empty packet with a sequence number.
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 saveGuts (BinStream &stream) const override
 Write the sequence number and the assignments of at most four players.
void restoreGuts (BinStream &stream) override
 Read the fields saveGuts() writes, after the assignments are removed.
void PrintExtra (PrnStream &stream) const override
 Write the sequence number and each player's track and slot.
const std::vector< PlayerData > & GetPlayers () const
std::vector< PlayerData > & GetPlayers ()
int GetVersion () const
Public Member Functions inherited from ExternalPacket
 ExternalPacket (unsigned char nFlags=0, int nReceiver=kAllPeers)
 Construct a packet from an unset sender.
int Route () override
 Report that a received packet goes to the sink of TheNetTransport.
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 Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet in which the arbitrating console assigns every player a track.

The RTTI records the class as deriving from ExternalPacket. The members Clone(), Type(), and GetName() are inline. The member names are inferred from the packet's printed form.

Constructor & Destructor Documentation

◆ ~ArbiterPacket()

ArbiterPacket::~ArbiterPacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003479f0
Ghidra address:
PAL: 0x003b4e20

◆ ArbiterPacket() [1/2]

ArbiterPacket::ArbiterPacket ( )
inline

Construct a packet with no assignments.

Inline. New() expands it.

◆ ArbiterPacket() [2/2]

ArbiterPacket::ArbiterPacket ( int nVersion)
inlineexplicit

Construct an empty packet with a sequence number.

Inline. NetArbiter::Broadcast() expands it on its stack.

Parameters
nVersionThe sequence number.

Member Function Documentation

◆ New()

Message * ArbiterPacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00122f18
Ghidra address:
PAL: 0x00124698

◆ operator new()

void * ArbiterPacket::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 ArbiterPacket::operator delete ( void * pBlock)
inline

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * ArbiterPacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00347b00
Ghidra address:
PAL: 0x003b4f30

Implements Message.

◆ Type()

int ArbiterPacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nArbiterPacketType.
Ghidra address:
NTSC-U/C: 0x00347b40
Ghidra address:
PAL: 0x003b4f70

Implements Message.

◆ GetName()

const char * ArbiterPacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal ArbiterPacket.
Ghidra address:
NTSC-U/C: 0x00347b50
Ghidra address:
PAL: 0x003b4f80

Implements Message.

◆ saveGuts()

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

Write the sequence number and the assignments of at most four players.

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

Reimplemented from Message.

◆ restoreGuts()

void ArbiterPacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the fields saveGuts() writes, after the assignments are removed.

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

Reimplemented from Message.

◆ PrintExtra()

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

Write the sequence number and each player's track and slot.

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

Reimplemented from Message.

◆ GetPlayers() [1/2]

const std::vector< PlayerData > & ArbiterPacket::GetPlayers ( ) const
inline
Returns
The assignments.

◆ GetPlayers() [2/2]

std::vector< PlayerData > & ArbiterPacket::GetPlayers ( )
inline
Returns
The assignments, for filling.

◆ GetVersion()

int ArbiterPacket::GetVersion ( ) const
inline
Returns
The sequence number of the player's last update.

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