prefetch_manager.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "kcenon/pacs/client/prefetch_types.h"
#include "kcenon/pacs/core/result.h"
#include "kcenon/pacs/di/ilogger.h"
 
#include <atomic>
#include <chrono>
#include <condition_variable>
#include <future>
#include <memory>
#include <mutex>
#include <optional>
#include <shared_mutex>
#include <string>
#include <string_view>
#include <thread>
#include <unordered_set>
#include <vector>
 
// Forward declarations
namespace kcenon::pacs::storage {
class prefetch_repository;
class prefetch_rule_repository;
class prefetch_history_repository;
}
 
namespace kcenon::pacs::services {
class worklist_scu;
}
 
namespace kcenon::pacs::core {
class dicom_dataset;
}
 
namespace kcenon::pacs::client {
 
// Forward declarations
class remote_node_manager;
class job_manager;
 
struct prefetch_repositories {
    std::shared_ptr<storage::prefetch_rule_repository> rules;
    std::shared_ptr<storage::prefetch_history_repository> history;
};
 
// =============================================================================
// Prefetch Manager
// =============================================================================
 
class prefetch_manager {
public:
    // =========================================================================
    // Construction / Destruction
    // =========================================================================
 
    explicit prefetch_manager(
        prefetch_repositories repositories,
        std::shared_ptr<remote_node_manager> node_manager,
        std::shared_ptr<job_manager> job_manager,
        std::shared_ptr<services::worklist_scu> worklist_scu = nullptr,
        std::shared_ptr<di::ILogger> logger = nullptr);
 
    explicit prefetch_manager(
        const prefetch_manager_config& config,
        prefetch_repositories repositories,
        std::shared_ptr<remote_node_manager> node_manager,
        std::shared_ptr<job_manager> job_manager,
        std::shared_ptr<services::worklist_scu> worklist_scu = nullptr,
        std::shared_ptr<di::ILogger> logger = nullptr);
 
    explicit prefetch_manager(
        std::shared_ptr<storage::prefetch_repository> repo,
        std::shared_ptr<remote_node_manager> node_manager,
        std::shared_ptr<job_manager> job_manager,
        std::shared_ptr<services::worklist_scu> worklist_scu = nullptr,
        std::shared_ptr<di::ILogger> logger = nullptr);
 
    explicit prefetch_manager(
        const prefetch_manager_config& config,
        std::shared_ptr<storage::prefetch_repository> repo,
        std::shared_ptr<remote_node_manager> node_manager,
        std::shared_ptr<job_manager> job_manager,
        std::shared_ptr<services::worklist_scu> worklist_scu = nullptr,
        std::shared_ptr<di::ILogger> logger = nullptr);
 
    ~prefetch_manager();
 
    // Non-copyable, non-movable (due to internal threading)
    prefetch_manager(const prefetch_manager&) = delete;
    auto operator=(const prefetch_manager&) -> prefetch_manager& = delete;
    prefetch_manager(prefetch_manager&&) = delete;
    auto operator=(prefetch_manager&&) -> prefetch_manager& = delete;
 
    // =========================================================================
    // Rule Management
    // =========================================================================
 
    [[nodiscard]] auto add_rule(const prefetch_rule& rule) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto update_rule(const prefetch_rule& rule) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto remove_rule(std::string_view rule_id) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto get_rule(std::string_view rule_id) const
        -> std::optional<prefetch_rule>;
 
    [[nodiscard]] auto list_rules() const -> std::vector<prefetch_rule>;
 
    // =========================================================================
    // Worklist-Driven Prefetch
    // =========================================================================
 
    void process_worklist(const std::vector<core::dicom_dataset>& worklist_items);
 
    [[nodiscard]] auto process_worklist_async(
        const std::vector<core::dicom_dataset>& worklist_items) -> std::future<void>;
 
    // =========================================================================
    // Prior Study Prefetch
    // =========================================================================
 
    [[nodiscard]] auto prefetch_priors(
        std::string_view patient_id,
        std::string_view current_modality,
        std::optional<std::string_view> body_part = std::nullopt) -> prefetch_result;
 
    [[nodiscard]] auto prefetch_priors_async(
        std::string_view patient_id,
        std::string_view current_modality,
        std::optional<std::string_view> body_part = std::nullopt)
        -> std::future<prefetch_result>;
 
    // =========================================================================
    // Manual Prefetch
    // =========================================================================
 
    [[nodiscard]] auto prefetch_study(
        std::string_view source_node_id,
        std::string_view study_uid) -> std::string;
 
    [[nodiscard]] auto prefetch_patient(
        std::string_view source_node_id,
        std::string_view patient_id,
        std::chrono::hours lookback = std::chrono::hours{8760}) -> std::string;
 
    // =========================================================================
    // Scheduler Control
    // =========================================================================
 
    void start_scheduler();
 
    void stop_scheduler();
 
    [[nodiscard]] auto is_scheduler_running() const noexcept -> bool;
 
    // =========================================================================
    // Worklist Monitor Control
    // =========================================================================
 
    void start_worklist_monitor(std::string_view worklist_node_id);
 
    void stop_worklist_monitor();
 
    [[nodiscard]] auto is_worklist_monitor_running() const noexcept -> bool;
 
    // =========================================================================
    // Status and Statistics
    // =========================================================================
 
    [[nodiscard]] auto pending_prefetches() const -> size_t;
 
    [[nodiscard]] auto completed_today() const -> size_t;
 
    [[nodiscard]] auto failed_today() const -> size_t;
 
    [[nodiscard]] auto get_rule_statistics(std::string_view rule_id) const
        -> prefetch_rule_statistics;
 
    // =========================================================================
    // Configuration
    // =========================================================================
 
    [[nodiscard]] auto config() const noexcept -> const prefetch_manager_config&;
 
    void set_config(prefetch_manager_config new_config);
 
private:
    // =========================================================================
    // Private Implementation
    // =========================================================================
 
    struct impl;
    std::unique_ptr<impl> impl_;
};
 
}  // namespace kcenon::pacs::client