IsEnumPacketType< enum_type > Struct Template Reference

Trait to mark an enumeration as a PacketType. More...

#include <packet.h>

Static Public Attributes
static constexpr bool	value = false
	True iff a PacketType.

Detailed Description

template<typename enum_type>
struct IsEnumPacketType< enum_type >

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.

Definition at line 33 of file packet.h.

Field Documentation

value

template<typename enum_type>

bool IsEnumPacketType< enum_type >::value = false

staticconstexpr

True iff a PacketType.

Definition at line 34 of file packet.h.

---

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

• src/network/core/packet.h