coding_scheme_protocol.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_DQ_MESSAGING_CODING_SCHEME_PROTOCOL_HPP
#define ORES_DQ_MESSAGING_CODING_SCHEME_PROTOCOL_HPP
 
#include <span>
#include <iosfwd>
#include <vector>
#include <expected>
#include "ores.comms/messaging/message_types.hpp"
#include "ores.comms/messaging/message_traits.hpp"
#include "ores.dq/domain/coding_scheme.hpp"
#include "ores.dq/domain/coding_scheme_authority_type.hpp"
 
namespace ores::dq::messaging {
 
// ============================================================================
// Coding Scheme Messages
// ============================================================================
 
struct get_coding_schemes_request final {
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_schemes_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_schemes_request& v);
 
struct get_coding_schemes_response final {
    std::vector<domain::coding_scheme> schemes;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_schemes_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_schemes_response& v);
 
struct get_coding_schemes_by_authority_type_request final {
    std::string authority_type;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_schemes_by_authority_type_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_schemes_by_authority_type_request& v);
 
struct get_coding_schemes_by_authority_type_response final {
    std::vector<domain::coding_scheme> schemes;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_schemes_by_authority_type_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_schemes_by_authority_type_response& v);
 
struct save_coding_scheme_request final {
    domain::coding_scheme scheme;
 
    std::vector<std::byte> serialize() const;
    static std::expected<save_coding_scheme_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const save_coding_scheme_request& v);
 
struct save_coding_scheme_response final {
    bool success;
    std::string message;
 
    std::vector<std::byte> serialize() const;
    static std::expected<save_coding_scheme_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const save_coding_scheme_response& v);
 
struct delete_coding_scheme_result final {
    std::string code;
    bool success;
    std::string message;
};
 
std::ostream& operator<<(std::ostream& s, const delete_coding_scheme_result& v);
 
struct delete_coding_scheme_request final {
    std::vector<std::string> codes;
 
    std::vector<std::byte> serialize() const;
    static std::expected<delete_coding_scheme_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const delete_coding_scheme_request& v);
 
struct delete_coding_scheme_response final {
    std::vector<delete_coding_scheme_result> results;
 
    std::vector<std::byte> serialize() const;
    static std::expected<delete_coding_scheme_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const delete_coding_scheme_response& v);
 
struct get_coding_scheme_history_request final {
    std::string code;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_scheme_history_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_scheme_history_request& v);
 
struct get_coding_scheme_history_response final {
    bool success;
    std::string message;
    std::vector<domain::coding_scheme> versions;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_scheme_history_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_scheme_history_response& v);
 
// ============================================================================
// Coding Scheme Authority Type Messages
// ============================================================================
 
struct get_coding_scheme_authority_types_request final {
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_scheme_authority_types_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_scheme_authority_types_request& v);
 
struct get_coding_scheme_authority_types_response final {
    std::vector<domain::coding_scheme_authority_type> authority_types;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_scheme_authority_types_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_scheme_authority_types_response& v);
 
struct save_coding_scheme_authority_type_request final {
    domain::coding_scheme_authority_type authority_type;
 
    std::vector<std::byte> serialize() const;
    static std::expected<save_coding_scheme_authority_type_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const save_coding_scheme_authority_type_request& v);
 
struct save_coding_scheme_authority_type_response final {
    bool success;
    std::string message;
 
    std::vector<std::byte> serialize() const;
    static std::expected<save_coding_scheme_authority_type_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const save_coding_scheme_authority_type_response& v);
 
struct delete_coding_scheme_authority_type_result final {
    std::string code;
    bool success;
    std::string message;
};
 
std::ostream& operator<<(std::ostream& s, const delete_coding_scheme_authority_type_result& v);
 
struct delete_coding_scheme_authority_type_request final {
    std::vector<std::string> codes;
 
    std::vector<std::byte> serialize() const;
    static std::expected<delete_coding_scheme_authority_type_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const delete_coding_scheme_authority_type_request& v);
 
struct delete_coding_scheme_authority_type_response final {
    std::vector<delete_coding_scheme_authority_type_result> results;
 
    std::vector<std::byte> serialize() const;
    static std::expected<delete_coding_scheme_authority_type_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const delete_coding_scheme_authority_type_response& v);
 
struct get_coding_scheme_authority_type_history_request final {
    std::string code;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_scheme_authority_type_history_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_scheme_authority_type_history_request& v);
 
struct get_coding_scheme_authority_type_history_response final {
    bool success;
    std::string message;
    std::vector<domain::coding_scheme_authority_type> versions;
 
    std::vector<std::byte> serialize() const;
    static std::expected<get_coding_scheme_authority_type_history_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_coding_scheme_authority_type_history_response& v);
 
}
 
namespace ores::comms::messaging {
 
// Coding Scheme traits
template<>
struct message_traits<dq::messaging::get_coding_schemes_request> {
    using request_type = dq::messaging::get_coding_schemes_request;
    using response_type = dq::messaging::get_coding_schemes_response;
    static constexpr message_type request_message_type =
        message_type::get_coding_schemes_request;
};
 
template<>
struct message_traits<dq::messaging::get_coding_schemes_by_authority_type_request> {
    using request_type = dq::messaging::get_coding_schemes_by_authority_type_request;
    using response_type = dq::messaging::get_coding_schemes_by_authority_type_response;
    static constexpr message_type request_message_type =
        message_type::get_coding_schemes_by_authority_type_request;
};
 
template<>
struct message_traits<dq::messaging::save_coding_scheme_request> {
    using request_type = dq::messaging::save_coding_scheme_request;
    using response_type = dq::messaging::save_coding_scheme_response;
    static constexpr message_type request_message_type =
        message_type::save_coding_scheme_request;
};
 
template<>
struct message_traits<dq::messaging::delete_coding_scheme_request> {
    using request_type = dq::messaging::delete_coding_scheme_request;
    using response_type = dq::messaging::delete_coding_scheme_response;
    static constexpr message_type request_message_type =
        message_type::delete_coding_scheme_request;
};
 
template<>
struct message_traits<dq::messaging::get_coding_scheme_history_request> {
    using request_type = dq::messaging::get_coding_scheme_history_request;
    using response_type = dq::messaging::get_coding_scheme_history_response;
    static constexpr message_type request_message_type =
        message_type::get_coding_scheme_history_request;
};
 
// Coding Scheme Authority Type traits
template<>
struct message_traits<dq::messaging::get_coding_scheme_authority_types_request> {
    using request_type = dq::messaging::get_coding_scheme_authority_types_request;
    using response_type = dq::messaging::get_coding_scheme_authority_types_response;
    static constexpr message_type request_message_type =
        message_type::get_coding_scheme_authority_types_request;
};
 
template<>
struct message_traits<dq::messaging::save_coding_scheme_authority_type_request> {
    using request_type = dq::messaging::save_coding_scheme_authority_type_request;
    using response_type = dq::messaging::save_coding_scheme_authority_type_response;
    static constexpr message_type request_message_type =
        message_type::save_coding_scheme_authority_type_request;
};
 
template<>
struct message_traits<dq::messaging::delete_coding_scheme_authority_type_request> {
    using request_type = dq::messaging::delete_coding_scheme_authority_type_request;
    using response_type = dq::messaging::delete_coding_scheme_authority_type_response;
    static constexpr message_type request_message_type =
        message_type::delete_coding_scheme_authority_type_request;
};
 
template<>
struct message_traits<dq::messaging::get_coding_scheme_authority_type_history_request> {
    using request_type = dq::messaging::get_coding_scheme_authority_type_history_request;
    using response_type = dq::messaging::get_coding_scheme_authority_type_history_response;
    static constexpr message_type request_message_type =
        message_type::get_coding_scheme_authority_type_history_request;
};
 
}
 
#endif