network_concepts.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 <concepts>
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <system_error>
#include <type_traits>
#include <vector>
 
// Note: common_system concepts are included via the parent concepts.h header
// to avoid forward declaration conflicts. Do not include concepts.h here directly.
 
namespace kcenon::network::concepts {
 
// ============================================================================
// Data Buffer Concepts
// ============================================================================
 
template <typename T>
concept ByteBuffer = requires(const T t) {
    { t.data() } -> std::convertible_to<const void*>;
    { t.size() } -> std::convertible_to<std::size_t>;
};
 
template <typename T>
concept MutableByteBuffer = ByteBuffer<T> && requires(T t, std::size_t n) {
    { t.resize(n) };
    { t.data() } -> std::convertible_to<void*>;
};
 
// ============================================================================
// Callback Concepts
// ============================================================================
 
template <typename F>
concept DataReceiveHandler =
    std::invocable<F, const std::vector<uint8_t>&>;
 
template <typename F>
concept ErrorHandler = std::invocable<F, std::error_code>;
 
template <typename F>
concept ConnectionHandler = std::invocable<F>;
 
template <typename F, typename Session>
concept SessionHandler = std::invocable<F, std::shared_ptr<Session>>;
 
template <typename F, typename Session>
concept SessionDataHandler =
    std::invocable<F, std::shared_ptr<Session>, const std::vector<uint8_t>&>;
 
template <typename F, typename Session>
concept SessionErrorHandler =
    std::invocable<F, std::shared_ptr<Session>, std::error_code>;
 
template <typename F>
concept DisconnectionHandler = std::invocable<F, const std::string&>;
 
template <typename F>
concept RetryCallback = std::invocable<F, std::size_t>;
 
// ============================================================================
// Network Component Concepts
// ============================================================================
 
template <typename T>
concept NetworkClient = requires(T t, std::vector<uint8_t> data) {
    { t.is_connected() } -> std::convertible_to<bool>;
    { t.send_packet(std::move(data)) };
    { t.stop_client() };
};
 
template <typename T>
concept NetworkServer = requires(T t, unsigned short port) {
    { t.start_server(port) };
    { t.stop_server() };
};
 
template <typename T>
concept NetworkSession = requires(T t) {
    { t.get_session_id() } -> std::convertible_to<std::string>;
    { t.start_session() };
    { t.stop_session() };
};
 
// ============================================================================
// Pipeline Concepts
// ============================================================================
 
template <typename T>
concept DataTransformer = requires(T t, std::vector<uint8_t>& data) {
    { t.transform(data) } -> std::convertible_to<bool>;
};
 
template <typename T>
concept ReversibleDataTransformer =
    DataTransformer<T> && requires(T t, std::vector<uint8_t>& data) {
        { t.reverse_transform(data) } -> std::convertible_to<bool>;
    };
 
// ============================================================================
// Duration Concepts
// ============================================================================
 
template <typename T>
concept Duration = requires {
    typename T::rep;
    typename T::period;
} && std::is_arithmetic_v<typename T::rep>;
 
// ============================================================================
// Integration with common_system concepts (when available)
// ============================================================================
// Note: Additional common_system integration concepts are defined in the
// parent concepts.h header after proper include order is established.
 
} // namespace kcenon::network::concepts