worklist_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_WORKLIST_SCP_HPP
#define PACS_SERVICES_WORKLIST_SCP_HPP
 
#include "scp_service.h"
 
#include <atomic>
#include <functional>
 
namespace kcenon::pacs::services {
 
// =============================================================================
// SOP Class UIDs (re-exported for convenience)
// =============================================================================
 
inline constexpr std::string_view worklist_find_sop_class_uid =
    "1.2.840.10008.5.1.4.31";
 
// =============================================================================
// Worklist Handler Type
// =============================================================================
 
using worklist_handler = std::function<std::vector<core::dicom_dataset>(
    const core::dicom_dataset& query_keys,
    const std::string& calling_ae)>;
 
using worklist_cancel_check = std::function<bool()>;
 
// =============================================================================
// Worklist SCP Class
// =============================================================================
 
class worklist_scp final : public scp_service {
public:
    // =========================================================================
    // Construction
    // =========================================================================
 
    explicit worklist_scp(std::shared_ptr<di::ILogger> logger = nullptr);
 
    ~worklist_scp() override = default;
 
    // =========================================================================
    // Configuration
    // =========================================================================
 
    void set_handler(worklist_handler handler);
 
    void set_max_results(size_t max) noexcept;
 
    [[nodiscard]] size_t max_results() const noexcept;
 
    void set_cancel_check(worklist_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 queries_processed() const noexcept;
 
    [[nodiscard]] size_t items_returned() const noexcept;
 
    void reset_statistics() noexcept;
 
private:
    // =========================================================================
    // Private Implementation
    // =========================================================================
 
    [[nodiscard]] network::Result<std::monostate> send_pending_response(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        const core::dicom_dataset& result);
 
    [[nodiscard]] network::Result<std::monostate> send_final_response(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        network::dimse::status_code status);
 
    // =========================================================================
    // Member Variables
    // =========================================================================
 
    worklist_handler handler_;
    worklist_cancel_check cancel_check_;
    size_t max_results_{0};  // 0 = unlimited
    std::atomic<size_t> queries_processed_{0};
    std::atomic<size_t> items_returned_{0};
};
 
}  // namespace kcenon::pacs::services
 
#endif  // PACS_SERVICES_WORKLIST_SCP_HPP