handshake_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_HANDSHAKE_PROTOCOL_HPP
#define ORES_COMMS_MESSAGING_HANDSHAKE_PROTOCOL_HPP
 
#include <string>
#include <vector>
#include <cstdint>
#include <expected>
#include "ores.comms/messaging/frame.hpp"
#include "ores.comms/messaging/error_protocol.hpp"
#include "ores.comms/messaging/message_traits.hpp"
 
namespace ores::comms::messaging {
 
constexpr std::uint8_t COMPRESSION_SUPPORT_ZLIB = 0x01;
constexpr std::uint8_t COMPRESSION_SUPPORT_GZIP = 0x02;
constexpr std::uint8_t COMPRESSION_SUPPORT_BZIP2 = 0x04;
constexpr std::uint8_t COMPRESSION_SUPPORT_ALL = 0x07;
 
struct handshake_request final {
    std::uint16_t client_version_major;
    std::uint16_t client_version_minor;
    std::string client_identifier;
    std::uint8_t supported_compression = 0;
 
    static std::vector<std::byte> serialize(handshake_request v);
 
    static std::expected<handshake_request, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
struct handshake_response final {
    std::uint16_t server_version_major;
    std::uint16_t server_version_minor;
    bool version_compatible;
    std::string server_identifier;
    ores::utility::serialization::error_code status;
    compression_type selected_compression = compression_type::none;
 
    static std::vector<std::byte> serialize(handshake_response v);
 
    static std::expected<handshake_response, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
struct handshake_ack final {
    ores::utility::serialization::error_code status;
 
    static std::vector<std::byte> serialize(handshake_ack v);
 
    static std::expected<handshake_ack, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
frame create_handshake_request_frame(
    std::uint32_t sequence,
    const std::string& client_identifier,
    std::uint8_t supported_compression = 0);
 
frame create_handshake_response_frame(
    std::uint32_t sequence,
    bool version_compatible,
    const std::string& server_identifier,
    ores::utility::serialization::error_code status = ores::utility::serialization::error_code::none,
    compression_type selected_compression = compression_type::none);
 
frame create_handshake_ack_frame(
    std::uint32_t sequence,
    ores::utility::serialization::error_code status = ores::utility::serialization::error_code::none);
 
frame create_error_response_frame(
    std::uint32_t sequence,
    std::uint32_t correlation_id,
    ores::utility::serialization::error_code code,
    const std::string& message);
 
compression_type select_compression(
    std::uint8_t supported_compression,
    compression_type preferred = compression_type::zlib);
 
template<>
struct message_traits<handshake_request> {
    using request_type = handshake_request;
    using response_type = handshake_response;
    static constexpr message_type request_message_type =
        message_type::handshake_request;
};
 
}
 
#endif