session_recorder.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_RECORDING_SESSION_RECORDER_HPP
#define ORES_COMMS_RECORDING_SESSION_RECORDER_HPP
 
#include <mutex>
#include <atomic>
#include <chrono>
#include <fstream>
#include <cstdint>
#include <expected>
#include <filesystem>
#include <boost/uuid/uuid.hpp>
#include "ores.logging/make_logger.hpp"
#include "ores.comms/messaging/frame.hpp"
#include "ores.comms/recording/session_file.hpp"
 
namespace ores::comms::recording {
 
class session_recorder final {
private:
    inline static std::string_view logger_name = "ores.comms.recording.session_recorder";
 
    static auto& lg() {
        using namespace ores::logging;
        static auto instance = make_logger(logger_name);
        return instance;
    }
 
public:
    session_recorder() = default;
    ~session_recorder();
 
    // Non-copyable
    session_recorder(const session_recorder&) = delete;
    session_recorder& operator=(const session_recorder&) = delete;
 
    // Non-movable (due to mutex)
    session_recorder(session_recorder&&) = delete;
    session_recorder& operator=(session_recorder&&) = delete;
 
    std::expected<std::filesystem::path, session_file_error> start(
        const std::filesystem::path& output_directory,
        const std::string& server_address,
        messaging::compression_type compression = messaging::compression_type::none);
 
    void stop();
 
    bool is_recording() const;
 
    void record_sent(const messaging::frame& f);
 
    void record_received(const messaging::frame& f);
 
    boost::uuids::uuid session_id() const;
 
    std::filesystem::path file_path() const;
 
    std::uint64_t frame_count() const;
 
private:
    session_file_error write_header(
        const std::string& server_address,
        messaging::compression_type compression);
 
    void record_frame(const messaging::frame& f, frame_direction direction);
 
    mutable std::mutex mutex_;
    std::ofstream file_;
    std::filesystem::path file_path_;
    boost::uuids::uuid session_id_;
    std::chrono::steady_clock::time_point start_time_;
    std::atomic<bool> recording_{false};
    std::atomic<std::uint64_t> frame_count_{0};
};
 
}
 
#endif