secure_messaging_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 <atomic>
#include <functional>
#include <future>
#include <memory>
#include <mutex>
#include <string>
#include <string_view>
#include <vector>
 
#include <asio.hpp>
#include <asio/ssl.hpp>
 
#include "internal/core/callback_indices.h"
#include "internal/tcp/secure_tcp_socket.h"
#include "kcenon/network/integration/thread_integration.h"
#include "kcenon/network/detail/utils/lifecycle_manager.h"
#include "kcenon/network/detail/utils/callback_manager.h"
#include "kcenon/network/detail/utils/result_types.h"
 
namespace kcenon::network::core
{
 
    class secure_messaging_client
        : public std::enable_shared_from_this<secure_messaging_client>
    {
    public:
        using receive_callback_t = std::function<void(const std::vector<uint8_t>&)>;
        using connected_callback_t = std::function<void()>;
        using disconnected_callback_t = std::function<void()>;
        using error_callback_t = std::function<void(std::error_code)>;
 
        explicit secure_messaging_client(std::string_view client_id,
                                         bool verify_cert = true);
 
        ~secure_messaging_client() noexcept;
 
        // Non-copyable, non-movable
        secure_messaging_client(const secure_messaging_client&) = delete;
        secure_messaging_client& operator=(const secure_messaging_client&) = delete;
        secure_messaging_client(secure_messaging_client&&) = delete;
        secure_messaging_client& operator=(secure_messaging_client&&) = delete;
 
        // =====================================================================
        // Lifecycle Management
        // =====================================================================
 
        [[nodiscard]] auto start_client(std::string_view host, unsigned short port) -> VoidResult;
 
        [[nodiscard]] auto stop_client() -> VoidResult;
 
        auto wait_for_stop() -> void;
 
        [[nodiscard]] auto is_running() const noexcept -> bool;
 
        [[nodiscard]] auto is_connected() const noexcept -> bool;
 
        [[nodiscard]] auto client_id() const -> const std::string&;
 
        // =====================================================================
        // Data Transfer
        // =====================================================================
 
        [[nodiscard]] auto send_packet(std::vector<uint8_t>&& data) -> VoidResult;
 
        // =====================================================================
        // Callback Setters
        // =====================================================================
 
        auto set_receive_callback(receive_callback_t callback) -> void;
 
        auto set_connected_callback(connected_callback_t callback) -> void;
 
        auto set_disconnected_callback(disconnected_callback_t callback) -> void;
 
        auto set_error_callback(error_callback_t callback) -> void;
 
    private:
        // =====================================================================
        // Internal Implementation Methods
        // =====================================================================
 
        auto do_start_impl(std::string_view host, unsigned short port) -> VoidResult;
 
        auto do_stop_impl() -> VoidResult;
 
        auto do_send_impl(std::vector<uint8_t>&& data) -> VoidResult;
 
        // =====================================================================
        // Internal Callback Helpers
        // =====================================================================
 
        auto set_connected(bool connected) -> void;
 
        auto invoke_receive_callback(const std::vector<uint8_t>& data) -> void;
 
        auto invoke_connected_callback() -> void;
 
        auto invoke_disconnected_callback() -> void;
 
        auto invoke_error_callback(std::error_code ec) -> void;
 
        // =====================================================================
        // Internal Socket Handlers
        // =====================================================================
 
        auto on_receive(const std::vector<uint8_t>& data) -> void;
 
        auto on_error(std::error_code ec) -> void;
 
    private:
        using callback_index = tcp_client_callback;
 
        using callbacks_t = utils::callback_manager<
            receive_callback_t,
            connected_callback_t,
            disconnected_callback_t,
            error_callback_t
        >;
 
        // =====================================================================
        // Member Variables
        // =====================================================================
 
        std::string client_id_;              
        utils::lifecycle_manager lifecycle_; 
        callbacks_t callbacks_;              
        std::atomic<bool> is_connected_{false}; 
        std::unique_ptr<asio::io_context>
            io_context_;    
        std::unique_ptr<asio::executor_work_guard<asio::io_context::executor_type>>
            work_guard_;    
        std::shared_ptr<integration::thread_pool_interface>
            thread_pool_;   
        std::future<void>
            io_context_future_; 
        std::unique_ptr<asio::ssl::context>
            ssl_context_;   
        std::shared_ptr<internal::secure_tcp_socket>
            socket_;        
        bool verify_cert_{true};        
    };
 
} // namespace kcenon::network::core