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

Packet that tells the other consoles of a remix session about a section change. More...

#include <sectionchangepacket.h>

Inheritance diagram for SectionChangePacket:
Collaboration diagram for SectionChangePacket:

Public Member Functions

 ~SectionChangePacket () override=default
 Destroy the object.
 SectionChangePacket ()
 Construct a packet with no section.
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 payload.
void restoreGuts (BinStream &stream) override
 Read the payload.
int GetSection () const
void SetSection (int nSection)
int GetTick () const
void SetTick (int nTick)
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 that tells the other consoles of a remix session about a section change.

The RTTI records the class as deriving from ExternalPacket. Delivery is guaranteed. The members Clone(), Type(), and GetName() are inline. The payload travels as one four-byte word, the section in the low four bits and the tick in the other 28.

Constructor & Destructor Documentation

◆ ~SectionChangePacket()

SectionChangePacket::~SectionChangePacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00340908
Ghidra address:
PAL: 0x003ade40

◆ SectionChangePacket()

SectionChangePacket::SectionChangePacket ( )
inline

Construct a packet with no section.

Inline. New() expands it.

Member Function Documentation

◆ New()

Message * SectionChangePacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x001232b0
Ghidra address:
PAL: 0x00124a30

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * SectionChangePacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x003409a8
Ghidra address:
PAL: 0x003adee0

Implements Message.

◆ Type()

int SectionChangePacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nSectionChangePacketType.
Ghidra address:
NTSC-U/C: 0x00340a20
Ghidra address:
PAL: 0x003adf58

Implements Message.

◆ GetName()

const char * SectionChangePacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal SectionChangePacket.
Ghidra address:
NTSC-U/C: 0x00340a30
Ghidra address:
PAL: 0x003adf68

Implements Message.

◆ saveGuts()

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

Write the payload.

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

Reimplemented from Message.

◆ restoreGuts()

void SectionChangePacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the payload.

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

Reimplemented from Message.

◆ GetSection()

int SectionChangePacket::GetSection ( ) const
inline
Returns
The section. Four bits travel.

◆ SetSection()

void SectionChangePacket::SetSection ( int nSection)
inline
Parameters
nSectionThe section. Four bits travel.

◆ GetTick()

int SectionChangePacket::GetTick ( ) const
inline
Returns
The tick of the change. 28 bits travel.

◆ SetTick()

void SectionChangePacket::SetTick ( int nTick)
inline
Parameters
nTickThe tick of the change. 28 bits travel.

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