ups_watch_scp.h

Go to the documentation of this file.

 
#ifndef PACS_SERVICES_UPS_WATCH_SCP_HPP
#define PACS_SERVICES_UPS_WATCH_SCP_HPP
 
#include "../scp_service.h"
 
#include <atomic>
#include <functional>
 
namespace kcenon::pacs::services {
 
// =============================================================================
// SOP Class UID
// =============================================================================
 
inline constexpr std::string_view ups_watch_sop_class_uid =
    "1.2.840.10008.5.1.4.34.6.2";
 
// =============================================================================
// Well-Known SOP Instance UID
// =============================================================================
 
inline constexpr std::string_view ups_global_subscription_instance_uid =
    "1.2.840.10008.5.1.4.34.5";
 
// =============================================================================
// N-ACTION Type Constants for UPS Watch
// =============================================================================
 
inline constexpr uint16_t ups_watch_action_subscribe = 3;
 
inline constexpr uint16_t ups_watch_action_unsubscribe = 4;
 
inline constexpr uint16_t ups_watch_action_suspend_global = 5;
 
// =============================================================================
// N-EVENT-REPORT Event Type Constants
// =============================================================================
 
inline constexpr uint16_t ups_event_state_report = 1;
 
inline constexpr uint16_t ups_event_cancel_requested = 2;
 
inline constexpr uint16_t ups_event_progress_report = 3;
 
inline constexpr uint16_t ups_event_scp_status_change = 4;
 
// =============================================================================
// Handler Types
// =============================================================================
 
using ups_subscribe_handler = std::function<network::Result<std::monostate>(
    const std::string& subscriber_ae,
    const std::string& workitem_uid,
    bool deletion_lock)>;
 
using ups_unsubscribe_handler = std::function<network::Result<std::monostate>(
    const std::string& subscriber_ae,
    const std::string& workitem_uid)>;
 
using ups_get_subscribers_handler = std::function<
    network::Result<std::vector<std::string>>(
        const std::string& workitem_uid)>;
 
using ups_event_callback = std::function<void(
    const std::string& subscriber_ae,
    uint16_t event_type_id,
    const std::string& workitem_uid,
    const core::dicom_dataset& event_info)>;
 
// =============================================================================
// UPS Watch SCP Class
// =============================================================================
 
class ups_watch_scp final : public scp_service {
public:
    // =========================================================================
    // Construction
    // =========================================================================
 
    explicit ups_watch_scp(std::shared_ptr<di::ILogger> logger = nullptr);
 
    ~ups_watch_scp() override = default;
 
    // =========================================================================
    // Configuration
    // =========================================================================
 
    void set_subscribe_handler(ups_subscribe_handler handler);
    void set_unsubscribe_handler(ups_unsubscribe_handler handler);
    void set_get_subscribers_handler(ups_get_subscribers_handler handler);
    void set_event_callback(ups_event_callback callback);
 
    // =========================================================================
    // 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;
 
    // =========================================================================
    // Event Notification
    // =========================================================================
 
    void notify_state_change(const std::string& workitem_uid,
                             const std::string& new_state);
 
    void notify_cancel_requested(const std::string& workitem_uid,
                                 const std::string& reason);
 
    void notify_progress(const std::string& workitem_uid,
                         int progress_percent);
 
    // =========================================================================
    // Statistics
    // =========================================================================
 
    [[nodiscard]] size_t subscriptions_created() const noexcept;
    [[nodiscard]] size_t subscriptions_removed() const noexcept;
    [[nodiscard]] size_t events_sent() const noexcept;
 
    void reset_statistics() noexcept;
 
private:
    // =========================================================================
    // Private Implementation
    // =========================================================================
 
    [[nodiscard]] network::Result<std::monostate> handle_n_action(
        network::association& assoc,
        uint8_t context_id,
        const network::dimse::dimse_message& request);
 
    [[nodiscard]] network::Result<std::monostate> handle_subscribe(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        const std::string& sop_instance_uid);
 
    [[nodiscard]] network::Result<std::monostate> handle_unsubscribe(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        const std::string& sop_instance_uid);
 
    [[nodiscard]] network::Result<std::monostate> handle_suspend_global(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id);
 
    [[nodiscard]] network::Result<std::monostate> send_n_action_response(
        network::association& assoc,
        uint8_t context_id,
        uint16_t message_id,
        const std::string& sop_instance_uid,
        uint16_t action_type_id,
        network::dimse::status_code status);
 
    void dispatch_event(uint16_t event_type_id,
                        const std::string& workitem_uid,
                        const core::dicom_dataset& event_info);
 
    // =========================================================================
    // Member Variables
    // =========================================================================
 
    ups_subscribe_handler subscribe_handler_;
    ups_unsubscribe_handler unsubscribe_handler_;
    ups_get_subscribers_handler get_subscribers_handler_;
    ups_event_callback event_callback_;
 
    std::atomic<size_t> subscriptions_created_{0};
    std::atomic<size_t> subscriptions_removed_{0};
    std::atomic<size_t> events_sent_{0};
};
 
}  // namespace kcenon::pacs::services
 
#endif  // PACS_SERVICES_UPS_WATCH_SCP_HPP