amacocian/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2026-07-21 01:59:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Codechange: give more context regarding the PacketType enumerations

Browse Source
This commit is contained in:
Rubidium
2026-02-18 17:43:29 +01:00
committed by rubidium42
parent 316eac1208
commit 0ad97043bb
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/network/core/packet.h
+10 -1
View File
@@ -19,7 +19,16 @@
typedef uint16_t PacketSize; ///< Size of the whole packet.
typedef uint8_t PacketType; ///< Identifier for the packet
/** Trait to mark an enumeration as a PacketType. */
/**
* Trait to mark an enumeration as a PacketType.
*
* All packets in the context of OpenTTD's protocols have the same basic structure.
* A single byte identifier of the packet and then two bytes for the length. That
* identifier is unique for each stream of packets, which are separate enumerations.
* This trait allows us to only allow one of these PacketType enumerations when
* creating the packet, but not any other enumeration. It is up to the developer to
* enusre that the right enumeration is used for a socket handler.
*/
template <typename enum_type>
struct IsEnumPacketType {
static constexpr bool value = false; ///< True iff a PacketType.