i_transport.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "types.h"
 
#include <cstddef>
#include <span>
#include <string_view>
#include <vector>
 
#include "kcenon/network/detail/utils/result_types.h"
 
namespace kcenon::network::unified {
 
class i_transport {
public:
    virtual ~i_transport() = default;
 
    // Non-copyable (interface class, typically used via unique_ptr/shared_ptr)
    i_transport(const i_transport&) = delete;
    i_transport& operator=(const i_transport&) = delete;
 
    // Movable (for transfer of ownership)
    i_transport(i_transport&&) = default;
    i_transport& operator=(i_transport&&) = default;
 
    // =========================================================================
    // Data Transfer Operations
    // =========================================================================
 
    [[nodiscard]] virtual auto send(std::span<const std::byte> data) -> VoidResult = 0;
 
    [[nodiscard]] virtual auto send(std::vector<uint8_t>&& data) -> VoidResult = 0;
 
    // =========================================================================
    // State Query Operations
    // =========================================================================
 
    [[nodiscard]] virtual auto is_connected() const noexcept -> bool = 0;
 
    [[nodiscard]] virtual auto id() const noexcept -> std::string_view = 0;
 
    [[nodiscard]] virtual auto remote_endpoint() const noexcept -> endpoint_info = 0;
 
    [[nodiscard]] virtual auto local_endpoint() const noexcept -> endpoint_info = 0;
 
protected:
    i_transport() = default;
};
 
}  // namespace kcenon::network::unified