i_quic_client.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/interfaces/i_network_component.h"
 
#include <cstdint>
#include <functional>
#include <optional>
#include <string>
#include <string_view>
#include <system_error>
#include <vector>
 
#include "kcenon/network/detail/utils/result_types.h"
 
namespace kcenon::network::interfaces
{
 
    class i_quic_client : public i_network_component
    {
    public:
        using receive_callback_t = std::function<void(const std::vector<uint8_t>&)>;
 
        using stream_callback_t = std::function<void(uint64_t, const std::vector<uint8_t>&, bool)>;
 
        using connected_callback_t = std::function<void()>;
 
        using disconnected_callback_t = std::function<void()>;
 
        using error_callback_t = std::function<void(std::error_code)>;
 
        using session_ticket_callback_t = std::function<void(
            std::vector<uint8_t> ticket_data,
            uint32_t lifetime_hint,
            uint32_t max_early_data)>;
 
        using early_data_callback_t = std::function<std::vector<uint8_t>()>;
 
        using early_data_accepted_callback_t = std::function<void(bool accepted)>;
 
        [[nodiscard]] virtual auto start(std::string_view host, uint16_t port) -> VoidResult = 0;
 
        [[nodiscard]] virtual auto stop() -> VoidResult = 0;
 
        [[nodiscard]] virtual auto is_connected() const -> bool = 0;
 
        [[nodiscard]] virtual auto is_handshake_complete() const -> bool = 0;
 
        // =====================================================================
        // Default Stream Operations
        // =====================================================================
 
        [[nodiscard]] virtual auto send(std::vector<uint8_t>&& data) -> VoidResult = 0;
 
        // =====================================================================
        // Multi-Stream Operations (QUIC Specific)
        // =====================================================================
 
        [[nodiscard]] virtual auto create_stream() -> Result<uint64_t> = 0;
 
        [[nodiscard]] virtual auto create_unidirectional_stream() -> Result<uint64_t> = 0;
 
        [[nodiscard]] virtual auto send_on_stream(
            uint64_t stream_id,
            std::vector<uint8_t>&& data,
            bool fin = false) -> VoidResult = 0;
 
        [[nodiscard]] virtual auto close_stream(uint64_t stream_id) -> VoidResult = 0;
 
        // =====================================================================
        // ALPN Configuration
        // =====================================================================
 
        virtual auto set_alpn_protocols(const std::vector<std::string>& protocols) -> void = 0;
 
        [[nodiscard]] virtual auto alpn_protocol() const -> std::optional<std::string> = 0;
 
        // =====================================================================
        // 0-RTT Support
        // =====================================================================
 
        [[nodiscard]] virtual auto is_early_data_accepted() const -> bool = 0;
 
        // =====================================================================
        // Callbacks
        // =====================================================================
 
        virtual auto set_receive_callback(receive_callback_t callback) -> void = 0;
 
        virtual auto set_stream_callback(stream_callback_t callback) -> void = 0;
 
        virtual auto set_connected_callback(connected_callback_t callback) -> void = 0;
 
        virtual auto set_disconnected_callback(disconnected_callback_t callback) -> void = 0;
 
        virtual auto set_error_callback(error_callback_t callback) -> void = 0;
 
        virtual auto set_session_ticket_callback(session_ticket_callback_t callback) -> void = 0;
 
        virtual auto set_early_data_callback(early_data_callback_t callback) -> void = 0;
 
        virtual auto set_early_data_accepted_callback(early_data_accepted_callback_t callback) -> void = 0;
    };
 
} // namespace kcenon::network::interfaces