retrieve_scp.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.
 
#ifndef PACS_SERVICES_RETRIEVE_SCP_HPP
#define PACS_SERVICES_RETRIEVE_SCP_HPP
 
#include "scp_service.h"
#include "kcenon/pacs/core/dicom_dataset.h"
#include "kcenon/pacs/core/dicom_file.h"
 
#include <atomic>
#include <functional>
#include <optional>
#include <string>
#include <utility>
#include <vector>
 
namespace kcenon::pacs::services {
 
// =============================================================================
// SOP Class UIDs
// =============================================================================
 
inline constexpr std::string_view patient_root_move_sop_class_uid =
    "1.2.840.10008.5.1.4.1.2.1.2";
 
inline constexpr std::string_view study_root_move_sop_class_uid =
    "1.2.840.10008.5.1.4.1.2.2.2";
 
inline constexpr std::string_view patient_root_get_sop_class_uid =
    "1.2.840.10008.5.1.4.1.2.1.3";
 
inline constexpr std::string_view study_root_get_sop_class_uid =
    "1.2.840.10008.5.1.4.1.2.2.3";
 
// =============================================================================
// Sub-operation Statistics
// =============================================================================
 
struct sub_operation_stats {
    uint16_t remaining{0};   
    uint16_t completed{0};   
    uint16_t failed{0};      
    uint16_t warning{0};     
 
    [[nodiscard]] uint16_t total() const noexcept {
        return remaining + completed + failed + warning;
    }
 
    [[nodiscard]] bool all_successful() const noexcept {
        return failed == 0;
    }
};
 
// =============================================================================
// Handler Types
// =============================================================================
 
using retrieve_handler = std::function<std::vector<core::dicom_file>(
    const core::dicom_dataset& query_keys)>;
 
using destination_resolver = std::function<
    std::optional<std::pair<std::string, uint16_t>>(
        const std::string& ae_title)>;
 
using store_sub_operation = std::function<network::dimse::status_code(
    network::association& assoc,
    uint8_t context_id,
    const core::dicom_file& file,
    const std::string& move_originator_ae,
    uint16_t move_originator_msg_id)>;
 
using retrieve_cancel_check = std::function<bool()>;
 
// =============================================================================
// Retrieve SCP Class
// =============================================================================
 
class retrieve_scp final : public scp_service {
public:
    // =========================================================================
    // Construction
    // =========================================================================
 
    explicit retrieve_scp(std::shared_ptr<di::ILogger> logger = nullptr);
 
    ~retrieve_scp() override = default;
 
    // =========================================================================
    // Configuration
    // =========================================================================
 
    void set_retrieve_handler(retrieve_handler handler);
 
    void set_destination_resolver(destination_resolver resolver);
 
    void set_store_sub_operation(store_sub_operation handler);
 
    void set_cancel_check(retrieve_cancel_check check);
 
    // =========================================================================
    // scp_service Interface Implementation
    // =========================================================================
 
    [[nodiscard]] std::vector<std::string> supported_sop_classes() const override;
 
    [[nodiscard]] network::Result<std::monostate> handle_message(
        network::association& assoc,
        uint8_t context_id,
        const network::dimse::dimse_message& request) override;
 
    [[nodiscard]] std::string_view service_name() const noexcept override;
 
    // =========================================================================
    // Statistics
    // =========================================================================
 
    [[nodiscard]] size_t move_operations() const noexcept;
 
    [[nodiscard]] size_t get_operations() const noexcept;
 
    [[nodiscard]] size_t images_transferred() const noexcept;
 
    void reset_statistics() noexcept;
 
private:
    // =========================================================================
    // Private Implementation
    // =========================================================================
 
    [[nodiscard]] network::Result<std::monostate> handle_c_move(
        network::association& assoc,
        uint8_t context_id,
        const network::dimse::dimse_message& request);
 
    [[nodiscard]] network::Result<std::monostate> handle_c_get(
        network::association& assoc,
        uint8_t context_id,
        const network::dimse::dimse_message& request);
 
    [[nodiscard]] network::Result<std::monostate> send_pending_response(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        std::string_view sop_class_uid,
        bool is_move,
        const sub_operation_stats& stats);
 
    [[nodiscard]] network::Result<std::monostate> send_final_response(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        std::string_view sop_class_uid,
        bool is_move,
        const sub_operation_stats& stats,
        bool was_cancelled);
 
    [[nodiscard]] std::string get_move_destination(
        const network::dimse::dimse_message& request) const;
 
    // =========================================================================
    // Member Variables
    // =========================================================================
 
    retrieve_handler retrieve_handler_;
    destination_resolver destination_resolver_;
    store_sub_operation store_handler_;
    retrieve_cancel_check cancel_check_;
 
    std::atomic<size_t> move_operations_{0};
    std::atomic<size_t> get_operations_{0};
    std::atomic<size_t> images_transferred_{0};
};
 
}  // namespace kcenon::pacs::services
 
#endif  // PACS_SERVICES_RETRIEVE_SCP_HPP