Metalama.Patterns.Caching 2024.2.2-preview

Prefix Reserved
This is a prerelease version of Metalama.Patterns.Caching.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Metalama.Patterns.Caching --version 2024.2.2-preview
                    
NuGet\Install-Package Metalama.Patterns.Caching -Version 2024.2.2-preview
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Metalama.Patterns.Caching" Version="2024.2.2-preview" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Metalama.Patterns.Caching" Version="2024.2.2-preview" />
                    
Directory.Packages.props
<PackageReference Include="Metalama.Patterns.Caching" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Metalama.Patterns.Caching --version 2024.2.2-preview
                    
#r "nuget: Metalama.Patterns.Caching, 2024.2.2-preview"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Metalama.Patterns.Caching&version=2024.2.2-preview&prerelease
                    
Install Metalama.Patterns.Caching as a Cake Addin
#tool nuget:?package=Metalama.Patterns.Caching&version=2024.2.2-preview&prerelease
                    
Install Metalama.Patterns.Caching as a Cake Tool

Metalama Logo

About

The Metalama.Patterns.Caching package is a front-end library for caching. It simplifies caching method results and invalidating the cached results.

This package is designed for use with the Metalama.Patterns.Caching.Aspects package, which offers Metalama-based aspects for caching, cache invalidation, and cache key generation. However, the Metalama.Patterns.Caching package does not rely on the Metalama aspect framework, and it can be used independently or with another aspect framework.

Key Features

  • Caching the return value of a method as a function of its arguments.
  • Invalidation of cached method results, both directly and indirectly through cache dependencies.
  • In-memory cache, Redis cache, Pub/Sub synchronized cache, L2 in-memory cache.
  • Caching profiles for dynamically changing settings at runtime.
  • Automatic reload of expired cached items.
  • Cache key formatters through the Flashtrace.Formatters package.
  • Value adapters for caching "special" types like streams or enumerables.
  • Locking to prevent concurrent execution.

This package can interact with any cache implementation. The abstraction is provided by the CachingBackend class from the Metalama.Patterns.Caching.Backend package.

Main Types

The primary types in this package are:

  • ICachingService is the main interface.
  • CachingService is the primary implementation of ICachingService and should generally not be directly used unless you are not using dependency injection.
  • CachingServiceFactory extends IServiceCollection and allows the addition of ICachingService to your application.
  • CachedMethodMetadata represents the metadata of a cached method. If you are not using an aspect framework, you must create an instance of this class for each cached method.
  • CacheKeyBuilder is the algorithm that generates the cache key based on the method metadata and its arguments.
  • IValueAdapter is the abstraction for caching special types like streams or enumerables.

Additional Documentation

  • Metalama.Patterns.Caching.Aspects provides an aspect-oriented API for the current package.
  • Metalama.Patterns.Caching.Backend defines the CachingBackend abstraction and provides core implementations for in-memory and multi-layered caching.
  • Metalama.Patterns.Caching.Backends.Redis offers the CachingBackend implementation for Redis.
  • Metalama.Patterns.Caching.Backends.Azure implements pub/sub synchronization of distributed in-memory caches through Azure Message Bus.
  • Flashtrace.Formatters provides an infrastructure for cache key formatting.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 is compatible.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on Metalama.Patterns.Caching:

Package Downloads
Shinya.Core

Shinya.Framework

Metalama.Patterns.Caching.Aspects

A set of aspects that simplify the caching: [Cache] to cache a method result as a function of its parameters, [InvalidateCache] to invalidate the cache, or [CacheKey] to mark a cache key in a class.

Metalama.Patterns.Caching.Backends.Redis

Redis back-end for Metalama.Patterns.Caching. Implements both caching and cache invalidation over Redis Pub/Sub

Metalama.Patterns.Caching.Backends.Azure

Synchronizes the invalidation of distributed Metalama.Patterns.Caching caches over Azure Service Bus.

Metalama.Patterns.Caching.TestHelpers

This package contains helper classes used when developing unit tests for new CachingBackend implementations. You don't need this package in any other scenarios.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2025.1.8 48 5/26/2025
2025.1.7 153 5/22/2025
2025.1.6 307 5/15/2025
2025.1.5 335 5/2/2025
2025.1.4-rc 308 4/15/2025
2025.1.3-rc 278 4/9/2025
2025.1.2-preview 274 4/1/2025
2025.1.1-preview 241 3/18/2025
2025.0.12 109 5/22/2025
2025.0.11 169 5/2/2025
2025.0.10 237 3/31/2025
2025.0.9 327 3/7/2025
2025.0.8 385 1/6/2025
2025.0.7-rc 280 12/6/2024
2025.0.6-rc 272 11/15/2024
2025.0.5-preview 164 11/8/2024
2025.0.4-preview 150 10/31/2024
2025.0.3-preview 153 10/25/2024
2025.0.2-preview 155 10/24/2024
2025.0.1-preview 139 10/14/2024
2024.2.32 275 3/7/2025
2024.2.31 194 12/6/2024
2024.2.30 202 11/15/2024
2024.2.29 204 10/31/2024
2024.2.28 196 10/25/2024
2024.2.27 182 10/24/2024
2024.2.26 228 10/14/2024
2024.2.25 211 10/2/2024
2024.2.24 256 9/10/2024
2024.2.23 1,190 8/30/2024
2024.2.22 217 8/29/2024
2024.2.21 195 8/28/2024
2024.2.20 255 8/15/2024
2024.2.19 835 8/1/2024
2024.2.18 185 7/29/2024
2024.2.17-rc 191 7/22/2024
2024.2.16-rc 160 7/18/2024
2024.2.15-rc 193 7/12/2024
2024.2.14-rc 197 7/8/2024
2024.2.13-rc 182 7/2/2024
2024.2.12-preview 177 6/28/2024
2024.2.11-preview 198 6/26/2024
2024.2.10-preview 173 6/20/2024
2024.2.9-preview 223 6/11/2024
2024.2.8-preview 135 6/6/2024
2024.2.7-preview 196 5/30/2024
2024.2.6-preview 198 5/25/2024
2024.2.5-preview 204 5/6/2024
2024.2.4-preview 186 5/4/2024
2024.2.3-preview 203 4/30/2024
2024.2.2-preview 187 4/23/2024
2024.2.1-preview 171 4/11/2024
2024.1.30 173 10/24/2024
2024.1.29 182 10/11/2024
2024.1.28 203 9/9/2024
2024.1.27 204 8/28/2024
2024.1.26 240 8/15/2024
2024.1.25 189 7/22/2024
2024.1.24 196 7/12/2024
2024.1.23 235 6/26/2024
2024.1.22 229 6/15/2024
2024.1.21 201 6/6/2024
2024.1.20 235 5/30/2024
2024.1.19 240 5/24/2024
2024.1.18 331 5/6/2024
2024.1.17 218 5/3/2024
2024.1.16 262 4/30/2024
2024.1.15 257 4/29/2024
2024.1.14 204 4/23/2024
2024.1.13 233 4/23/2024
2024.1.12 259 4/17/2024
2024.1.11-rc 172 4/11/2024
2024.1.10-rc 177 4/4/2024
2024.1.9-rc 194 3/27/2024
2024.1.8-preview 173 3/25/2024
2024.1.7-preview 192 3/19/2024
2024.1.6-preview 215 3/6/2024
2024.1.5-preview 203 2/29/2024
2024.1.4-preview 237 2/27/2024
2024.1.3-preview 207 2/23/2024
2024.1.2-preview 213 2/7/2024
2024.1.1-preview 165 1/30/2024
2024.0.16 261 6/15/2024
2024.0.15 216 6/6/2024
2024.0.14 214 5/30/2024
2024.0.13 229 5/24/2024
2024.0.12 244 4/17/2024
2024.0.11 239 3/21/2024
2024.0.10 223 3/19/2024
2024.0.9 243 2/29/2024
2024.0.8 244 2/23/2024
2024.0.7 242 2/7/2024
2024.0.6 301 1/3/2024
2024.0.5-rc 216 12/21/2023
2024.0.4-rc 206 12/12/2023
2024.0.3-preview 203 12/6/2023
2024.0.2-preview 212 11/14/2023
2024.0.1-preview 211 11/6/2023
2023.4.9 255 2/7/2024
2023.4.8 255 12/21/2023
2023.4.7 245 12/12/2023
2023.4.6 287 11/7/2023
2023.4.5-rc 218 10/26/2023
2023.4.4-preview 195 10/18/2023
2023.4.3-preview 201 10/4/2023
2023.4.2-preview 209 9/26/2023
2023.3.10-preview 185 12/21/2023
2023.3.9-preview 201 12/12/2023
2023.3.8-preview 246 10/17/2023
2023.3.7-preview 189 9/29/2023
2023.3.6-preview 217 9/26/2023
2023.3.5-preview 171 9/13/2023
2023.3.4-preview 191 8/30/2023