quic_session.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 <atomic>
#include <functional>
#include <memory>
#include <mutex>
#include <string>
#include <string_view>
#include <vector>
 
#include <asio.hpp>
 
// Enable experimental QUIC API for quic_connection_stats type
#ifndef NETWORK_USE_EXPERIMENTAL
#define NETWORK_USE_EXPERIMENTAL
#endif
#include "kcenon/network/internal/experimental/quic_client.h"
#include "kcenon/network/internal/interfaces/i_quic_server.h"
#include "kcenon/network/detail/protocols/quic/connection_id.h"
#include "kcenon/network/detail/utils/result_types.h"
 
namespace kcenon::network::internal
{
    class quic_socket;
} // namespace kcenon::network::internal
 
namespace kcenon::network::session
{
 
    class quic_session
        : public std::enable_shared_from_this<quic_session>
        , public interfaces::i_quic_session
    {
    public:
        quic_session(std::shared_ptr<internal::quic_socket> socket,
                     std::string_view session_id);
 
        ~quic_session() noexcept;
 
        // Disable copy
        quic_session(const quic_session&) = delete;
        quic_session& operator=(const quic_session&) = delete;
 
        // =====================================================================
        // Session Information
        // =====================================================================
 
        [[nodiscard]] auto session_id() const -> const std::string&;
 
        [[nodiscard]] auto remote_endpoint() const -> asio::ip::udp::endpoint;
 
        [[nodiscard]] auto is_active() const noexcept -> bool;
 
        // =====================================================================
        // Data Transfer (Legacy API)
        // =====================================================================
 
        [[nodiscard]] auto send(std::string_view data) -> VoidResult;
 
        // =====================================================================
        // Session Management (Legacy API)
        // =====================================================================
 
        [[nodiscard]] auto close(uint64_t error_code) -> VoidResult;
 
        // =====================================================================
        // Statistics
        // =====================================================================
 
        [[nodiscard]] auto stats() const -> core::quic_connection_stats;
 
        // =====================================================================
        // Callbacks
        // =====================================================================
 
        auto set_receive_callback(
            std::function<void(const std::vector<uint8_t>&)> callback) -> void;
 
        auto set_stream_receive_callback(
            std::function<void(uint64_t, const std::vector<uint8_t>&, bool)>
                callback) -> void;
 
        auto set_close_callback(std::function<void()> callback) -> void;
 
        // =====================================================================
        // Internal Methods (for server use)
        // =====================================================================
 
        auto start_session() -> void;
 
        auto handle_packet(std::span<const uint8_t> data) -> void;
 
        [[nodiscard]] auto matches_connection_id(
            const protocols::quic::connection_id& conn_id) const -> bool;
 
        // =====================================================================
        // i_quic_session interface implementation
        // =====================================================================
 
        [[nodiscard]] auto id() const -> std::string_view override {
            return session_id_;
        }
 
        [[nodiscard]] auto is_connected() const -> bool override {
            return is_active();
        }
 
        [[nodiscard]] auto send(std::vector<uint8_t>&& data) -> VoidResult override;
 
        auto close() -> void override {
            auto result = close(0);
            (void)result;
        }
 
        [[nodiscard]] auto create_stream() -> Result<uint64_t> override;
 
        [[nodiscard]] auto create_unidirectional_stream() -> Result<uint64_t> override;
 
        [[nodiscard]] auto send_on_stream(
            uint64_t stream_id,
            std::vector<uint8_t>&& data,
            bool fin = false) -> VoidResult override;
 
        [[nodiscard]] auto close_stream(uint64_t stream_id) -> VoidResult override;
 
    private:
        // =====================================================================
        // Internal Callbacks
        // =====================================================================
 
        auto on_stream_data(uint64_t stream_id,
                            std::span<const uint8_t> data,
                            bool fin) -> void;
 
        auto on_error(std::error_code ec) -> void;
 
        auto on_close(uint64_t error_code, const std::string& reason) -> void;
 
        // =====================================================================
        // Member Variables
        // =====================================================================
 
        std::string session_id_;
 
        mutable std::mutex socket_mutex_;
        std::shared_ptr<internal::quic_socket> socket_;
 
        std::atomic<bool> is_active_{true};
 
        uint64_t default_stream_id_{0};
 
        // Callbacks
        std::function<void(const std::vector<uint8_t>&)> receive_callback_;
        std::function<void(uint64_t, const std::vector<uint8_t>&, bool)>
            stream_receive_callback_;
        std::function<void()> close_callback_;
 
        mutable std::mutex callback_mutex_;
    };
 
} // namespace kcenon::network::session