transport_params.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "kcenon/network/detail/protocols/quic/connection_id.h"
#include "kcenon/network/detail/utils/result_types.h"
 
#include <array>
#include <cstdint>
#include <optional>
#include <span>
#include <vector>
 
namespace kcenon::network::protocols::quic
{
 
namespace transport_param_id
{
    constexpr uint64_t original_destination_connection_id = 0x00;
    constexpr uint64_t max_idle_timeout = 0x01;
    constexpr uint64_t stateless_reset_token = 0x02;
    constexpr uint64_t max_udp_payload_size = 0x03;
    constexpr uint64_t initial_max_data = 0x04;
    constexpr uint64_t initial_max_stream_data_bidi_local = 0x05;
    constexpr uint64_t initial_max_stream_data_bidi_remote = 0x06;
    constexpr uint64_t initial_max_stream_data_uni = 0x07;
    constexpr uint64_t initial_max_streams_bidi = 0x08;
    constexpr uint64_t initial_max_streams_uni = 0x09;
    constexpr uint64_t ack_delay_exponent = 0x0a;
    constexpr uint64_t max_ack_delay = 0x0b;
    constexpr uint64_t disable_active_migration = 0x0c;
    constexpr uint64_t preferred_address = 0x0d;
    constexpr uint64_t active_connection_id_limit = 0x0e;
    constexpr uint64_t initial_source_connection_id = 0x0f;
    constexpr uint64_t retry_source_connection_id = 0x10;
} // namespace transport_param_id
 
namespace transport_param_error
{
    constexpr int invalid_parameter = -720;
    constexpr int decode_error = -721;
    constexpr int duplicate_parameter = -722;
    constexpr int missing_required_parameter = -723;
    constexpr int invalid_value = -724;
} // namespace transport_param_error
 
struct preferred_address_info
{
    std::array<uint8_t, 4> ipv4_address{};
    uint16_t ipv4_port{0};
    std::array<uint8_t, 16> ipv6_address{};
    uint16_t ipv6_port{0};
    class connection_id connection_id;
    std::array<uint8_t, 16> stateless_reset_token{};
 
    [[nodiscard]] auto operator==(const preferred_address_info& other) const -> bool
    {
        return ipv4_address == other.ipv4_address && ipv4_port == other.ipv4_port &&
               ipv6_address == other.ipv6_address && ipv6_port == other.ipv6_port &&
               connection_id == other.connection_id &&
               stateless_reset_token == other.stateless_reset_token;
    }
};
 
struct transport_parameters
{
    // ========================================================================
    // Connection IDs (only set by server or during retry)
    // ========================================================================
 
    std::optional<connection_id> original_destination_connection_id;
 
    std::optional<connection_id> initial_source_connection_id;
 
    std::optional<connection_id> retry_source_connection_id;
 
    std::optional<std::array<uint8_t, 16>> stateless_reset_token;
 
    // ========================================================================
    // Timing Parameters
    // ========================================================================
 
    uint64_t max_idle_timeout{0};
 
    uint64_t ack_delay_exponent{3};
 
    uint64_t max_ack_delay{25};
 
    // ========================================================================
    // Flow Control Parameters
    // ========================================================================
 
    uint64_t max_udp_payload_size{65527};
 
    uint64_t initial_max_data{0};
 
    uint64_t initial_max_stream_data_bidi_local{0};
 
    uint64_t initial_max_stream_data_bidi_remote{0};
 
    uint64_t initial_max_stream_data_uni{0};
 
    // ========================================================================
    // Stream Limits
    // ========================================================================
 
    uint64_t initial_max_streams_bidi{0};
 
    uint64_t initial_max_streams_uni{0};
 
    // ========================================================================
    // Connection Options
    // ========================================================================
 
    bool disable_active_migration{false};
 
    uint64_t active_connection_id_limit{2};
 
    std::optional<preferred_address_info> preferred_address;
 
    // ========================================================================
    // Encoding / Decoding
    // ========================================================================
 
    [[nodiscard]] auto encode() const -> std::vector<uint8_t>;
 
    [[nodiscard]] static auto decode(std::span<const uint8_t> data)
        -> Result<transport_parameters>;
 
    // ========================================================================
    // Validation
    // ========================================================================
 
    [[nodiscard]] auto validate(bool is_server) const -> VoidResult;
 
    void apply_defaults();
 
    // ========================================================================
    // Comparison
    // ========================================================================
 
    [[nodiscard]] auto operator==(const transport_parameters& other) const -> bool = default;
};
 
[[nodiscard]] auto make_default_client_params() -> transport_parameters;
 
[[nodiscard]] auto make_default_server_params() -> transport_parameters;
 
} // namespace kcenon::network::protocols::quic