messaging_udp_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 <functional>
#include <future>
#include <memory>
#include <mutex>
#include <string>
#include <string_view>
#include <vector>
 
#include <asio.hpp>
 
#include "internal/core/callback_indices.h"
#include "internal/interfaces/i_udp_client.h"
#include "kcenon/network/detail/utils/result_types.h"
#include "kcenon/network/detail/utils/lifecycle_manager.h"
#include "kcenon/network/detail/utils/callback_manager.h"
#include "kcenon/network/integration/thread_integration.h"
 
namespace kcenon::network::internal
{
    class udp_socket;
}
 
namespace kcenon::network::core
{
    class messaging_udp_client
        : public std::enable_shared_from_this<messaging_udp_client>
        , public interfaces::i_udp_client
    {
    public:
        using receive_callback_t = std::function<void(const std::vector<uint8_t>&,
                                                      const asio::ip::udp::endpoint&)>;
        using error_callback_t = std::function<void(std::error_code)>;
 
        explicit messaging_udp_client(std::string_view client_id);
 
        ~messaging_udp_client() noexcept override;
 
        // Non-copyable, non-movable
        messaging_udp_client(const messaging_udp_client&) = delete;
        messaging_udp_client& operator=(const messaging_udp_client&) = delete;
        messaging_udp_client(messaging_udp_client&&) = delete;
        messaging_udp_client& operator=(messaging_udp_client&&) = delete;
 
        // ========================================================================
        // Lifecycle Management
        // ========================================================================
 
        [[nodiscard]] auto start_client(std::string_view host, uint16_t port) -> VoidResult;
 
        [[nodiscard]] auto stop_client() -> VoidResult;
 
        [[nodiscard]] auto client_id() const -> const std::string&;
 
        // ========================================================================
        // i_network_component interface implementation
        // ========================================================================
 
        [[nodiscard]] auto is_running() const -> bool override;
 
        auto wait_for_stop() -> void override;
 
        // ========================================================================
        // i_udp_client interface implementation
        // ========================================================================
 
        [[nodiscard]] auto start(std::string_view host, uint16_t port) -> VoidResult override;
 
        [[nodiscard]] auto stop() -> VoidResult override;
 
        [[nodiscard]] auto send(
            std::vector<uint8_t>&& data,
            interfaces::i_udp_client::send_callback_t handler = nullptr) -> VoidResult override;
 
        [[nodiscard]] auto set_target(std::string_view host, uint16_t port) -> VoidResult override;
 
        auto set_receive_callback(interfaces::i_udp_client::receive_callback_t callback) -> void override;
 
        auto set_receive_callback(receive_callback_t callback) -> void;
 
        auto set_error_callback(error_callback_t callback) -> void override;
 
    private:
        // =====================================================================
        // Internal Implementation Methods
        // =====================================================================
 
        auto do_start_impl(std::string_view host, uint16_t port) -> VoidResult;
 
        auto do_stop_impl() -> VoidResult;
 
        // =====================================================================
        // Internal Callback Helpers
        // =====================================================================
 
        auto invoke_receive_callback(const std::vector<uint8_t>& data,
                                     const asio::ip::udp::endpoint& endpoint) -> void;
 
        auto invoke_error_callback(std::error_code ec) -> void;
 
        [[nodiscard]] auto get_receive_callback() const -> receive_callback_t;
 
        [[nodiscard]] auto get_error_callback() const -> error_callback_t;
 
        using callback_index = udp_client_callback;
 
        using callbacks_t = utils::callback_manager<
            receive_callback_t,
            error_callback_t
        >;
 
        // =====================================================================
        // Member Variables
        // =====================================================================
 
        std::string client_id_;                          
        utils::lifecycle_manager lifecycle_;             
        callbacks_t callbacks_;                          
        std::unique_ptr<asio::io_context> io_context_;   
        std::shared_ptr<internal::udp_socket> socket_;   
        std::shared_ptr<integration::thread_pool_interface> thread_pool_;   
        std::future<void> io_context_future_;            
        std::mutex endpoint_mutex_;                      
        asio::ip::udp::endpoint target_endpoint_;        
        mutable std::mutex socket_mutex_;                
    };
 
} // namespace kcenon::network::core