handshake_service.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_SERVICE_HANDSHAKE_SERVICE_HPP
#define ORES_COMMS_SERVICE_HANDSHAKE_SERVICE_HPP
 
#include <string>
#include <cstdint>
#include <optional>
#include <functional>
#include <boost/asio/awaitable.hpp>
#include "ores.logging/make_logger.hpp"
#include "ores.comms/messaging/message_types.hpp"
 
namespace ores::comms::net { class connection; }
 
namespace ores::comms::service {
 
struct handshake_result {
    messaging::compression_type compression;
    std::string client_identifier;
    std::uint16_t client_version_major;
    std::uint16_t client_version_minor;
};
 
class handshake_service final {
private:
    inline static std::string_view logger_name =
        "ores.comms.service.handshake_service";
 
    static auto& lg() {
        using namespace ores::logging;
        static auto instance = make_logger(logger_name);
        return instance;
    }
 
public:
    static boost::asio::awaitable<messaging::compression_type> perform_client_handshake(
        net::connection& conn,
        const std::function<std::uint32_t()>& sequence_generator,
        const std::string& client_identifier,
        std::uint8_t supported_compression = 0);
 
    static boost::asio::awaitable<std::optional<handshake_result>>
    perform_server_handshake(
        net::connection& conn,
        std::uint32_t sequence,
        const std::string& server_identifier);
};
 
}
 
#endif