query_cache.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/services/cache/simple_lru_cache.h>
 
#include <chrono>
#include <memory>
#include <string>
#include <vector>
 
namespace kcenon::pacs::services::cache {
 
// ─────────────────────────────────────────────────────
// Forward Declarations
// ─────────────────────────────────────────────────────
 
class query_cache;
 
// ─────────────────────────────────────────────────────
// Query Cache Configuration
// ─────────────────────────────────────────────────────
 
struct query_cache_config {
    std::size_t max_entries{1000};
 
    std::chrono::seconds ttl{300};
 
    bool enable_logging{false};
 
    bool enable_metrics{true};
 
    std::string cache_name{"cfind_query_cache"};
};
 
// ─────────────────────────────────────────────────────
// Query Result Type
// ─────────────────────────────────────────────────────
 
struct cached_query_result {
    std::vector<std::uint8_t> data;
 
    std::uint32_t match_count{0};
 
    std::chrono::steady_clock::time_point cached_at;
 
    std::string query_level;
};
 
// ─────────────────────────────────────────────────────
// Query Cache Implementation
// ─────────────────────────────────────────────────────
 
class query_cache {
public:
    using key_type = std::string;
    using value_type = cached_query_result;
    using size_type = std::size_t;
 
    // =========================================================================
    // Construction
    // =========================================================================
 
    explicit query_cache(const query_cache_config& config = query_cache_config{});
 
    query_cache(const query_cache&) = delete;
    query_cache& operator=(const query_cache&) = delete;
 
    query_cache(query_cache&&) noexcept = default;
    query_cache& operator=(query_cache&&) noexcept = default;
 
    ~query_cache() = default;
 
    // =========================================================================
    // Cache Operations
    // =========================================================================
 
    [[nodiscard]] std::optional<cached_query_result> get(const key_type& key);
 
    void put(const key_type& key, const cached_query_result& result);
 
    void put(const key_type& key, cached_query_result&& result);
 
    bool invalidate(const key_type& key);
 
    size_type invalidate_by_prefix(const std::string& prefix);
 
    size_type invalidate_by_query_level(const std::string& query_level);
 
    template <typename Predicate>
    size_type invalidate_if(Predicate pred) {
        return cache_.invalidate_if(std::move(pred));
    }
 
    void clear();
 
    size_type purge_expired();
 
    // =========================================================================
    // Cache Information
    // =========================================================================
 
    [[nodiscard]] size_type size() const;
 
    [[nodiscard]] bool empty() const;
 
    [[nodiscard]] size_type max_size() const noexcept;
 
    [[nodiscard]] const cache_stats& stats() const noexcept;
 
    [[nodiscard]] double hit_rate() const noexcept;
 
    void reset_stats() noexcept;
 
    // =========================================================================
    // Key Generation Helpers
    // =========================================================================
 
    [[nodiscard]] static std::string build_key(
        const std::string& query_level,
        const std::vector<std::pair<std::string, std::string>>& params);
 
    [[nodiscard]] static std::string build_key_with_ae(
        const std::string& calling_ae,
        const std::string& query_level,
        const std::vector<std::pair<std::string, std::string>>& params);
 
private:
    query_cache_config config_;
    string_lru_cache<cached_query_result> cache_;
};
 
// ─────────────────────────────────────────────────────
// Global Query Cache Instance
// ─────────────────────────────────────────────────────
 
[[nodiscard]] query_cache& global_query_cache();
 
bool configure_global_cache(const query_cache_config& config);
 
}  // namespace kcenon::pacs::services::cache