HandshakeHeader_8hpp_source.html

#pragma once


#include "PacketReader.hpp"

#include "PacketWriter.hpp"

#include <cstddef>

#include <cstdint>


constexpr std::uint32_t MAGIC = 0x52545950;

constexpr std::uint8_t VERSION = 1;


enum class HandshakeType : std::uint8_t {

  Hello = 1,

  Welcome = 2,

  Rejected = 3,

};


struct HandshakeHeader {

  std::uint32_t magic = MAGIC;

  std::uint8_t version = VERSION;

  HandshakeType type = HandshakeType::Hello;


  static constexpr std::size_t HEADER_SIZE = 6;


  bool serialize(PacketWriter &writer) const;


  bool deserialize(PacketReader &reader);

};


PacketReader
Bounds checked reader of big-endian values over a byte buffer.
Definition PacketReader.hpp:15

PacketWriter
Growable buffer of big-endian values, capped at MAX_PAYLOAD_SIZE.
Definition PacketWriter.hpp:16

HandshakeType
HandshakeType
Kind of handshake datagram.
Definition HandshakeHeader.hpp:21

VERSION
constexpr std::uint8_t VERSION
Protocol version announced and expected during the handshake.
Definition HandshakeHeader.hpp:16

MAGIC
constexpr std::uint32_t MAGIC
Magic number that starts every handshake datagram, "RTYP" in ASCII.
Definition HandshakeHeader.hpp:14

HandshakeType::Welcome
@ Welcome
Server accepts the client and gives its connection id.

HandshakeType::Hello
@ Hello
Client asks the server to open a connection.

HandshakeType::Rejected
@ Rejected
Server refuses the connection.

HandshakeHeader
Header of the datagrams exchanged before a connection exists.
Definition HandshakeHeader.hpp:38

HandshakeHeader::HEADER_SIZE
static constexpr std::size_t HEADER_SIZE
Encoded size of the header, in bytes.
Definition HandshakeHeader.hpp:44

HandshakeHeader::type
HandshakeType type
Handshake step.
Definition HandshakeHeader.hpp:41

HandshakeHeader::deserialize
bool deserialize(PacketReader &reader)
Reads and validates the magic number and handshake type.
Definition HandshakeHeader.cpp:9

HandshakeHeader::version
std::uint8_t version
Protocol version.
Definition HandshakeHeader.hpp:40

HandshakeHeader::serialize
bool serialize(PacketWriter &writer) const
Writes the header in network byte order.
Definition HandshakeHeader.cpp:4

HandshakeHeader::magic
std::uint32_t magic
Protocol magic number.
Definition HandshakeHeader.hpp:39