subscription_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_COMMS_MESSAGING_SUBSCRIPTION_PROTOCOL_HPP
#define ORES_COMMS_MESSAGING_SUBSCRIPTION_PROTOCOL_HPP
 
#include <span>
#include <chrono>
#include <iosfwd>
#include <vector>
#include <cstdint>
#include <expected>
#include <string>
#include "ores.comms/messaging/message_types.hpp"
#include "ores.comms/messaging/message_traits.hpp"
#include "ores.eventing/domain/event_channel_info.hpp"
 
namespace ores::comms::messaging {
 
struct subscribe_request final {
    std::string event_type;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<subscribe_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const subscribe_request& v);
 
struct subscribe_response final {
    bool success;
    std::string message;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<subscribe_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const subscribe_response& v);
 
struct unsubscribe_request final {
    std::string event_type;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<unsubscribe_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const unsubscribe_request& v);
 
struct unsubscribe_response final {
    bool success;
    std::string message;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<unsubscribe_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const unsubscribe_response& v);
 
struct notification_message final {
    std::string event_type;
 
    std::chrono::system_clock::time_point timestamp;
 
    std::vector<std::string> entity_ids;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<notification_message, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const notification_message& v);
 
struct database_status_message final {
    bool available;
 
    std::string error_message;
 
    std::chrono::system_clock::time_point timestamp;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<database_status_message, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const database_status_message& v);
 
struct list_event_channels_request final {
    std::vector<std::byte> serialize() const;
 
    static std::expected<list_event_channels_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const list_event_channels_request& v);
 
struct list_event_channels_response final {
    std::vector<eventing::domain::event_channel_info> channels;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<list_event_channels_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const list_event_channels_response& v);
 
template<>
struct message_traits<subscribe_request> {
    using request_type = subscribe_request;
    using response_type = subscribe_response;
    static constexpr message_type request_message_type =
        message_type::subscribe_request;
};
 
template<>
struct message_traits<unsubscribe_request> {
    using request_type = unsubscribe_request;
    using response_type = unsubscribe_response;
    static constexpr message_type request_message_type =
        message_type::unsubscribe_request;
};
 
template<>
struct message_traits<list_event_channels_request> {
    using request_type = list_event_channels_request;
    using response_type = list_event_channels_response;
    static constexpr message_type request_message_type =
        message_type::list_event_channels_request;
};
 
}
 
#endif