heartbeat_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_HEARTBEAT_PROTOCOL_HPP
#define ORES_COMMS_MESSAGING_HEARTBEAT_PROTOCOL_HPP
 
#include <vector>
#include <cstdint>
#include <expected>
#include "ores.comms/messaging/frame.hpp"
 
namespace ores::comms::messaging {
 
struct ping final {
    static std::vector<std::byte> serialize(ping v);
 
    static std::expected<ping, error_code>
    deserialize(std::span<const std::byte> data);
};
 
struct pong final {
    static std::vector<std::byte> serialize(pong v);
 
    static std::expected<pong, error_code>
    deserialize(std::span<const std::byte> data);
};
 
frame create_ping_frame(std::uint32_t sequence, std::uint32_t correlation_id = 0);
 
frame create_pong_frame(std::uint32_t sequence, std::uint32_t correlation_id = 0);
 
}
 
#endif