i_websocket_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 <string>
#include <string_view>
#include <system_error>
#include <vector>
 
#include "kcenon/network/detail/utils/result_types.h"
 
namespace kcenon::network::interfaces
{
 
    class i_websocket_client : public i_network_component
    {
    public:
        using text_callback_t = std::function<void(const std::string&)>;
 
        using binary_callback_t = std::function<void(const std::vector<uint8_t>&)>;
 
        using connected_callback_t = std::function<void()>;
 
        using disconnected_callback_t = std::function<void(uint16_t code, std::string_view reason)>;
 
        using error_callback_t = std::function<void(std::error_code)>;
 
        using send_callback_t = std::function<void(std::error_code, std::size_t)>;
 
        [[nodiscard]] virtual auto start(
            std::string_view host,
            uint16_t port,
            std::string_view path = "/") -> VoidResult = 0;
 
        [[nodiscard]] virtual auto stop() -> VoidResult = 0;
 
        [[nodiscard]] virtual auto is_connected() const -> bool = 0;
 
        [[nodiscard]] virtual auto send_text(
            std::string&& message,
            send_callback_t handler = nullptr) -> VoidResult = 0;
 
        [[nodiscard]] virtual auto send_binary(
            std::vector<uint8_t>&& data,
            send_callback_t handler = nullptr) -> VoidResult = 0;
 
        [[nodiscard]] virtual auto ping(std::vector<uint8_t>&& payload = {}) -> VoidResult = 0;
 
        [[nodiscard]] virtual auto close(
            uint16_t code = 1000,
            std::string_view reason = "") -> VoidResult = 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_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;
    };
 
} // namespace kcenon::network::interfaces