job_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/job_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 <queue>
#include <shared_mutex>
#include <string>
#include <string_view>
#include <thread>
#include <vector>
 
// Forward declarations
namespace kcenon::pacs::storage {
class job_repository;
}
 
namespace kcenon::pacs::client {
 
// Forward declaration
class remote_node_manager;
 
// =============================================================================
// Job Manager
// =============================================================================
 
class job_manager {
public:
    // =========================================================================
    // Construction / Destruction
    // =========================================================================
 
    explicit job_manager(
        std::shared_ptr<storage::job_repository> repo,
        std::shared_ptr<remote_node_manager> node_manager,
        std::shared_ptr<di::ILogger> logger = nullptr);
 
    explicit job_manager(
        const job_manager_config& config,
        std::shared_ptr<storage::job_repository> repo,
        std::shared_ptr<remote_node_manager> node_manager,
        std::shared_ptr<di::ILogger> logger = nullptr);
 
    ~job_manager();
 
    // Non-copyable, non-movable (due to internal threading)
    job_manager(const job_manager&) = delete;
    auto operator=(const job_manager&) -> job_manager& = delete;
    job_manager(job_manager&&) = delete;
    auto operator=(job_manager&&) -> job_manager& = delete;
 
    // =========================================================================
    // Job Creation
    // =========================================================================
 
    [[nodiscard]] auto create_retrieve_job(
        std::string_view source_node_id,
        std::string_view study_uid,
        std::optional<std::string_view> series_uid = std::nullopt,
        job_priority priority = job_priority::normal) -> std::string;
 
    [[nodiscard]] auto create_store_job(
        std::string_view destination_node_id,
        const std::vector<std::string>& instance_uids,
        job_priority priority = job_priority::normal) -> std::string;
 
    [[nodiscard]] auto create_query_job(
        std::string_view node_id,
        std::string_view query_level,
        const std::unordered_map<std::string, std::string>& query_keys,
        job_priority priority = job_priority::normal) -> std::string;
 
    [[nodiscard]] auto create_sync_job(
        std::string_view source_node_id,
        std::optional<std::string_view> patient_id = std::nullopt,
        job_priority priority = job_priority::low) -> std::string;
 
    [[nodiscard]] auto create_prefetch_job(
        std::string_view source_node_id,
        std::string_view patient_id,
        job_priority priority = job_priority::low) -> std::string;
 
    // =========================================================================
    // Job Control
    // =========================================================================
 
    [[nodiscard]] auto start_job(std::string_view job_id) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto pause_job(std::string_view job_id) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto resume_job(std::string_view job_id) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto cancel_job(std::string_view job_id) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto retry_job(std::string_view job_id) -> kcenon::pacs::VoidResult;
 
    [[nodiscard]] auto delete_job(std::string_view job_id) -> kcenon::pacs::VoidResult;
 
    // =========================================================================
    // Job Queries
    // =========================================================================
 
    [[nodiscard]] auto get_job(std::string_view job_id) const
        -> std::optional<job_record>;
 
    [[nodiscard]] auto list_jobs(
        std::optional<job_status> status = std::nullopt,
        std::optional<job_type> type = std::nullopt,
        size_t limit = 100,
        size_t offset = 0) const -> std::vector<job_record>;
 
    [[nodiscard]] auto list_jobs_by_node(std::string_view node_id) const
        -> std::vector<job_record>;
 
    // =========================================================================
    // Progress Monitoring
    // =========================================================================
 
    [[nodiscard]] auto get_progress(std::string_view job_id) const -> job_progress;
 
    void set_progress_callback(job_progress_callback callback);
 
    void set_completion_callback(job_completion_callback callback);
 
    // =========================================================================
    // Wait for Completion
    // =========================================================================
 
    [[nodiscard]] auto wait_for_completion(std::string_view job_id)
        -> std::future<job_record>;
 
    // =========================================================================
    // Worker Management
    // =========================================================================
 
    void start_workers();
 
    void stop_workers();
 
    [[nodiscard]] auto is_running() const noexcept -> bool;
 
    // =========================================================================
    // Statistics
    // =========================================================================
 
    [[nodiscard]] auto active_jobs() const -> size_t;
 
    [[nodiscard]] auto pending_jobs() const -> size_t;
 
    [[nodiscard]] auto completed_jobs_today() const -> size_t;
 
    [[nodiscard]] auto failed_jobs_today() const -> size_t;
 
    // =========================================================================
    // Configuration
    // =========================================================================
 
    [[nodiscard]] auto config() const noexcept -> const job_manager_config&;
 
private:
    // =========================================================================
    // Private Implementation
    // =========================================================================
 
    struct impl;
    std::unique_ptr<impl> impl_;
};
 
}  // namespace kcenon::pacs::client