Polymorphic wire packet: opcode + payload hook.
More...
#include <StormByte/network/transport/packet.hxx>
|
| using | OpcodeType = unsigned short |
| | Opcode storage type.
|
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).
◆ OpcodeType
◆ Packet() [1/3]
| StormByte::Network::Transport::Packet::Packet |
( |
const Packet & | other | ) |
|
Copy constructor.
- Parameters
-
◆ Packet() [2/3]
| StormByte::Network::Transport::Packet::Packet |
( |
Packet && | other | ) |
|
|
noexcept |
Move constructor.
- Parameters
-
◆ ~Packet()
| virtual StormByte::Network::Transport::Packet::~Packet |
( |
| ) |
|
|
virtualnoexcept |
◆ Packet() [3/3]
| StormByte::Network::Transport::Packet::Packet |
( |
const OpcodeType & | opcode | ) |
|
|
inlineconstexprprotectednoexcept |
Construct with an opcode.
- Parameters
-
◆ DoSerialize()
|
|
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
-
- Returns
- This packet.
◆ operator=() [2/2]
| Packet & StormByte::Network::Transport::Packet::operator= |
( |
Packet && | other | ) |
|
|
noexcept |
Move assignment.
- Parameters
-
- Returns
- This packet.
◆ Serialize()
| Buffer::FIFO StormByte::Network::Transport::Packet::Serialize |
( |
| ) |
const |
|
noexcept |
Serialize opcode followed by DoSerialize() payload.
- Returns
- Complete on-wire buffer.
◆ m_opcode
| OpcodeType StormByte::Network::Transport::Packet::m_opcode |
|
protected |
The documentation for this class was generated from the following file: