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

Packet a guest sends the host to acknowledge a DataBlockPkt. More...

#include <dataackpkt.h>

Inheritance diagram for DataAckPkt:
Collaboration diagram for DataAckPkt:

Public Member Functions

 ~DataAckPkt () override=default
 Destroy the object.
 DataAckPkt ()
 Construct a packet for the host.
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.
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 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.

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.

Static Public Attributes

static constexpr int kHost = 0
 The identifier in the session of the host, the receiver of every packet of the class.
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.

Additional Inherited Members

Public Types inherited from Packet
enum  RouteFlag { kRouteTransport = 1 , kRouteLaunchpad = 2 }
 Bits of Route(). More...
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 a guest sends the host to acknowledge a DataBlockPkt.

The RTTI records the class as deriving from InternalPacket, and its vtable is at 0x003d4500. Delivery is guaranteed, to the host. The class adds no member, and its payload routines are those of Packet. The members Clone(), Type(), and GetName() are inline.

Constructor & Destructor Documentation

◆ ~DataAckPkt()

DataAckPkt::~DataAckPkt ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00398e50
Ghidra address:
PAL: 0x004076d8

◆ DataAckPkt()

DataAckPkt::DataAckPkt ( )
inline

Construct a packet for the host.

Inline. New() expands it.

Member Function Documentation

◆ New()

Message * DataAckPkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00267860
Ghidra address:
PAL: 0x00271538

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * DataAckPkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x00398ed0
Ghidra address:
PAL: 0x00407758

Implements Message.

◆ Type()

int DataAckPkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nDataAckPktType.
Ghidra address:
NTSC-U/C: 0x00398f38
Ghidra address:
PAL: 0x004077c0

Implements Message.

◆ GetName()

const char * DataAckPkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal DataAckPkt.
Ghidra address:
NTSC-U/C: 0x00398f48
Ghidra address:
PAL: 0x004077d0

Implements Message.

Member Data Documentation

◆ kHost

int DataAckPkt::kHost = 0
staticconstexpr

The identifier in the session of the host, the receiver of every packet of the class.


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