Table of Contents

Namespace Excalibur.Dispatch.Caching

Classes

CacheAttributeInfo

Information about cache attributes.

CacheBehaviorOptions

Expiration, timeout, and behavior configuration for cache operations.

CacheCircuitBreakerOptions

Circuit breaker configuration for cache resilience.

CacheHealthMonitor

Implementation of cache health monitoring.

CacheHealthStatus

Represents cache health status.

CacheKeyScopeOptions

Configures the partition a scoped distributed cache writes into.

CacheOptions

Configuration options for the Dispatch caching system. Supports memory, distributed, and hybrid caching modes.

CacheOptionsValidator

Validates CacheOptions at startup via the ValidateOnStart pipeline.

CachePerformanceSnapshot

Represents a snapshot of cache performance metrics at a specific point in time.

CacheReentrancyException

Thrown when a handler whose result is cached dispatches another message that resolves to the cache key currently being produced, directly or through a further dispatch.

CacheResilienceOptions

Configuration options for cache resilience features including circuit breaker and memory limits.

CacheResultAttribute

Attribute to mark dispatch actions for result caching with configurable options. Applied at the class level to enable caching for the entire message handler result.

CacheTypeNameOptions

Type name cache configuration for cache resilience.

CacheableInfo

Information about a cacheable type.

CachedValue

Cached value wrapper that preserves type information for proper deserialization. Must be public for System.Text.Json serialization when using distributed caching.

CachedValueJsonConverter

Custom JSON converter for CachedValue that handles polymorphic serialization of the Value property using the TypeName field.

CommonDelegates

Common cached delegates for message processing.

DefaultCacheKeyBuilder

Default implementation of cache key builder that creates consistent cache keys for dispatch actions. Uses JSON serialization for generating stable keys based on action content.

DefaultResultCachePolicy

Default implementation of result cache policy that uses a delegate function to determine caching behavior. Provides flexible caching logic based on message and result content.

DistributedCacheOptions

Configuration specific to distributed caching.

DistributedCacheServiceKeys

Service keys under which specially-scoped IDistributedCache registrations are published.

InMemoryCacheTagTracker

In-process implementation of ICacheTagTracker using a bounded ConcurrentDictionary<TKey, TValue> of per-tag version stamps. Thread-safe for single-process scenarios (Memory cache mode, or Distributed/Hybrid mode where cross-instance tag propagation is not required).

InvalidateCacheAttribute

Attribute to mark dispatch actions that should invalidate cache entries when executed. Applied at the class level to trigger cache invalidation after successful message processing.

MessageTypeMetadata

Pre-computed metadata for a message type to avoid runtime reflection.

Interfaces

ICacheHealthMonitor

Interface for monitoring cache health and performance.

ICacheInvalidationService

Service for removing cached entries.

ICacheInvalidator

Message contract used to trigger cache invalidation.

ICacheKeyBuilder

Creates cache keys for dispatch requests.

ICacheTagTracker

Tracks per-tag version stamps used to invalidate tagged cache entries without an atomic key-set backend.

ICacheable

Declares that a message's result may be cached, and describes how.

ICacheable<T>

Declares that a message returning T may have its result cached.

IResultCachePolicy

Determines whether results should be cached for a dispatch message.

IResultCachePolicy<TMessage>

Determines whether results should be cached for a specific message type.

Enums

CacheMode

Defines the caching mode for the Dispatch caching system.