StormByte-Network 4.0.0
C++26 networking module of the StormByte suite
Loading...
Searching...
No Matches
packet.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Network.
5 *
6 * StormByte-Network original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Network source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte Buffer tree), which
23 * remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Network is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Network. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
43#include <StormByte/buffer/fifo.hxx>
45#include <StormByte/safe/binary.hxx>
46#include <StormByte/serializable.hxx>
47#include <StormByte/type_traits/safe.hxx>
48
53namespace StormByte {
58 namespace Network {
63 namespace Transport {
74 public:
78 using OpcodeType = unsigned short;
79
84 Packet(const Packet& other);
85
90 Packet(Packet&& other) noexcept;
91
95 virtual ~Packet() noexcept;
96
102 Packet& operator=(const Packet& other);
103
109 Packet& operator=(Packet&& other) noexcept;
110
115 inline const OpcodeType& Opcode() const noexcept {
116 return m_opcode;
117 }
118
123 Buffer::FIFO Serialize() const noexcept;
124
125 protected:
127
132 constexpr Packet(const OpcodeType& opcode) noexcept:
133 m_opcode(opcode) {}
134
139 virtual StormByte::Safe::Binary DoSerialize() const noexcept = 0;
140 };
141 }
142 }
143}
144
145STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Network::Transport::Packet);
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Packet(Packet &&other) noexcept
Move constructor.
Buffer::FIFO Serialize() const noexcept
Serialize opcode followed by DoSerialize() payload.
const OpcodeType & Opcode() const noexcept
Stored opcode.
Definition packet.hxx:115
Packet(const Packet &other)
Copy constructor.
OpcodeType m_opcode
Packet opcode.
Definition packet.hxx:126
virtual ~Packet() noexcept
Destructor.
unsigned short OpcodeType
Opcode storage type.
Definition packet.hxx:78
virtual StormByte::Safe::Binary DoSerialize() const noexcept=0
Payload-only serialization (no opcode).
Transport namespace.
Network module of the StormByte suite.
Root namespace of the StormByte suite.
#define STORMBYTE_NETWORK_PUBLIC
Definition visibility.h:51