i_websocket_server.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 "kcenon/network/interfaces/i_session.h"
 
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <string_view>
#include <system_error>
#include <vector>
 
#include "kcenon/network/detail/utils/result_types.h"
 
namespace kcenon::network::interfaces
{
 
    class i_websocket_session : public i_session
    {
    public:
        [[nodiscard]] virtual auto send_text(std::string&& message) -> VoidResult = 0;
 
        [[nodiscard]] virtual auto send_binary(std::vector<uint8_t>&& data) -> VoidResult = 0;
 
        virtual auto close(uint16_t code, std::string_view reason = "") -> void = 0;
 
        [[nodiscard]] virtual auto path() const -> std::string_view = 0;
    };
 
    class i_websocket_server : public i_network_component
    {
    public:
        using connection_callback_t = std::function<void(std::shared_ptr<i_websocket_session>)>;
 
        using disconnection_callback_t = std::function<void(
            std::string_view session_id,
            uint16_t code,
            std::string_view reason)>;
 
        using text_callback_t = std::function<void(std::string_view, const std::string&)>;
 
        using binary_callback_t = std::function<void(std::string_view, const std::vector<uint8_t>&)>;
 
        using error_callback_t = std::function<void(std::string_view, std::error_code)>;
 
        [[nodiscard]] virtual auto start(uint16_t port) -> VoidResult = 0;
 
        [[nodiscard]] virtual auto stop() -> VoidResult = 0;
 
        [[nodiscard]] virtual auto connection_count() const -> size_t = 0;
 
        virtual auto set_connection_callback(connection_callback_t callback) -> void = 0;
 
        virtual auto set_disconnection_callback(disconnection_callback_t callback) -> void = 0;
 
        virtual auto set_text_callback(text_callback_t callback) -> void = 0;
 
        virtual auto set_binary_callback(binary_callback_t callback) -> void = 0;
 
        virtual auto set_error_callback(error_callback_t callback) -> void = 0;
    };
 
} // namespace kcenon::network::interfaces