StormByte-Network 4.0.0
C++26 networking module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Network::Transport::Packet Class Referenceabstract

Polymorphic wire packet: opcode + payload hook. More...

#include <StormByte/network/transport/packet.hxx>

Public Types

using OpcodeType = unsigned short
 Opcode storage type.

Public Member Functions

 Packet (const Packet &other)
 Copy constructor.
 Packet (Packet &&other) noexcept
 Move constructor.
virtual ~Packet () noexcept
 Destructor.
Packet & operator= (const Packet &other)
 Copy assignment.
Packet & operator= (Packet &&other) noexcept
 Move assignment.
const OpcodeType & Opcode () const noexcept
 Stored opcode.
Buffer::FIFO Serialize () const noexcept
 Serialize opcode followed by DoSerialize() payload.

Protected Member Functions

constexpr Packet (const OpcodeType &opcode) noexcept
 Construct with an opcode.
virtual StormByte::Safe::Binary DoSerialize () const noexcept=0
 Payload-only serialization (no opcode).

Protected Attributes

OpcodeType m_opcode
 Packet opcode.

Detailed Description

Polymorphic wire packet: opcode + payload hook.

Derive and override DoSerialize() for the payload (excluding opcode). Serialize() writes opcode then payload.

Opcodes must fit OpcodeType (unsigned short).

Member Typedef Documentation

◆ OpcodeType

Opcode storage type.

Constructor & Destructor Documentation

◆ Packet() [1/3]

StormByte::Network::Transport::Packet::Packet ( const Packet & other)

Copy constructor.

Parameters
otherSource packet.

◆ Packet() [2/3]

StormByte::Network::Transport::Packet::Packet ( Packet && other)
noexcept

Move constructor.

Parameters
otherSource packet.

◆ ~Packet()

virtual StormByte::Network::Transport::Packet::~Packet ( )
virtualnoexcept

Destructor.

◆ Packet() [3/3]

StormByte::Network::Transport::Packet::Packet ( const OpcodeType & opcode)
inlineconstexprprotectednoexcept

Construct with an opcode.

Parameters
opcodePacket opcode.

Member Function Documentation

◆ DoSerialize()

virtual StormByte::Safe::Binary StormByte::Network::Transport::Packet::DoSerialize ( ) const
protectedpure virtualnoexcept

Payload-only serialization (no opcode).

Returns
Payload bytes (may be empty).

◆ Opcode()

const OpcodeType & StormByte::Network::Transport::Packet::Opcode ( ) const
inlinenoexcept

Stored opcode.

Returns
Const reference to the stored opcode.

◆ operator=() [1/2]

Packet & StormByte::Network::Transport::Packet::operator= ( const Packet & other)

Copy assignment.

Parameters
otherSource packet.
Returns
This packet.

◆ operator=() [2/2]

Packet & StormByte::Network::Transport::Packet::operator= ( Packet && other)
noexcept

Move assignment.

Parameters
otherSource packet.
Returns
This packet.

◆ Serialize()

Buffer::FIFO StormByte::Network::Transport::Packet::Serialize ( ) const
noexcept

Serialize opcode followed by DoSerialize() payload.

Returns
Complete on-wire buffer.

Member Data Documentation

◆ m_opcode

OpcodeType StormByte::Network::Transport::Packet::m_opcode
protected

Packet opcode.


The documentation for this class was generated from the following file:
  • lib/public/StormByte/network/transport/packet.hxx