storage_commitment_endpoints.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 <chrono>
#include <map>
#include <mutex>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include "kcenon/pacs/services/storage_commitment_types.h"
 
namespace kcenon::pacs::web {
 
struct rest_server_context;
 
namespace storage_commitment {
 
enum class transaction_state {
    pending,    
    success,    
    partial,    
    failure     
};
 
[[nodiscard]] std::string_view to_string(transaction_state state) noexcept;
 
[[nodiscard]] std::optional<transaction_state> parse_state(
    std::string_view str) noexcept;
 
struct commitment_transaction {
    std::string transaction_uid;
 
    transaction_state state{transaction_state::pending};
 
    std::vector<services::sop_reference> requested_references;
 
    std::vector<services::sop_reference> success_references;
 
    std::vector<std::pair<services::sop_reference,
                          services::commitment_failure_reason>> failed_references;
 
    std::string study_instance_uid;
 
    std::chrono::system_clock::time_point created_at;
 
    std::optional<std::chrono::system_clock::time_point> completed_at;
};
 
class transaction_store {
public:
    void add(commitment_transaction txn);
 
    [[nodiscard]] std::optional<commitment_transaction> find(
        std::string_view transaction_uid) const;
 
    bool update(const commitment_transaction& txn);
 
    [[nodiscard]] std::vector<commitment_transaction> list(
        size_t limit = 0) const;
 
    [[nodiscard]] size_t size() const;
 
private:
    mutable std::mutex mutex_;
    std::map<std::string, commitment_transaction, std::less<>> transactions_;
};
 
[[nodiscard]] std::string transaction_to_json(const commitment_transaction& txn);
 
[[nodiscard]] std::string transactions_to_json(
    const std::vector<commitment_transaction>& transactions);
 
struct parse_result {
    std::vector<services::sop_reference> references;
    std::string error_message;
    bool valid{false};
};
 
[[nodiscard]] parse_result parse_commitment_request(
    std::string_view json_body,
    std::string_view study_uid = "");
 
}  // namespace storage_commitment
 
namespace endpoints {
 
// Internal function - implementation in cpp file
// Registers storage commitment endpoints with the Crow app
// Called from rest_server.cpp
 
}  // namespace endpoints
 
}  // namespace kcenon::pacs::web