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

Packet that asks a console for its clock, to measure the delay to it. More...

#include <timerequestpkt.h>

Inheritance diagram for TimeRequestPkt:
Collaboration diagram for TimeRequestPkt:

Public Member Functions

 ~TimeRequestPkt () override=default
 Destroy the object.
 TimeRequestPkt ()=default
 Construct a packet with mSendTime left unset.
 TimeRequestPkt (int nReceiver, float fSendTime)
 Construct a packet for one peer, with no delivery flag.
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 sender, the receiver, and the time of the request.
void saveGuts (BinStream &stream) const override
 Write the time of the request.
void restoreGuts (BinStream &stream) override
 Read the time of the request.
float GetSendTime () 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
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 that asks a console for its clock, to measure the delay to it.

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

◆ ~TimeRequestPkt()

TimeRequestPkt::~TimeRequestPkt ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003a0ab8
Ghidra address:
PAL: 0x0040f798

◆ TimeRequestPkt() [1/2]

TimeRequestPkt::TimeRequestPkt ( )
default

Construct a packet with mSendTime left unset.

Inline. New() expands it.

◆ TimeRequestPkt() [2/2]

TimeRequestPkt::TimeRequestPkt ( int nReceiver,
float fSendTime )
inline

Construct a packet for one peer, with no delivery flag.

Inline.

Parameters
nReceiverThe peer the packet is for.
fSendTimeThe clock of this console now.

Member Function Documentation

◆ New()

Message * TimeRequestPkt::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00267640
Ghidra address:
PAL: 0x00271318

◆ operator new()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * TimeRequestPkt::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.

Implements Message.

◆ Type()

int TimeRequestPkt::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nTimeRequestPktType.

Implements Message.

◆ GetName()

const char * TimeRequestPkt::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal TimeRequestPkt.

Implements Message.

◆ PrintExtra()

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

Write the sender, the receiver, and the time of the request.

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

Reimplemented from Packet.

◆ saveGuts()

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

Write the time of the request.

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

Reimplemented from Message.

◆ restoreGuts()

void TimeRequestPkt::restoreGuts ( BinStream & stream)
overridevirtual

Read the time of the request.

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

Reimplemented from Message.

◆ GetSendTime()

float TimeRequestPkt::GetSendTime ( ) const
inline
Returns
The clock of the requesting console when it sent the packet.

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