Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitfaster/BitFaster.Caching
High performance, thread-safe in-memory caching primitives for .NET
https://github.com/bitfaster/BitFaster.Caching
cache dotnet lfu lru threadsafe
Last synced: about 2 months ago
JSON representation
High performance, thread-safe in-memory caching primitives for .NET
- Host: GitHub
- URL: https://github.com/bitfaster/BitFaster.Caching
- Owner: bitfaster
- License: mit
- Created: 2020-06-11T02:55:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-05T18:48:10.000Z (3 months ago)
- Last Synced: 2024-07-06T00:20:58.480Z (3 months ago)
- Topics: cache, dotnet, lfu, lru, threadsafe
- Language: C#
- Homepage:
- Size: 1.31 MB
- Stars: 409
- Watchers: 6
- Forks: 24
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-dotnet - BitFaster.Caching - Thread-safe in-memory caches optimized for very high concurrent throughput, near optimal hit rate and low latency. (Caching)
README
# ⚡ BitFaster.Caching
High performance, thread-safe in-memory caching primitives for .NET.
[](https://badge.fury.io/nu/BitFaster.Caching)   [](https://coveralls.io/github/bitfaster/BitFaster.Caching?branch=main)
# Features
- [ConcurrentLru](https://github.com/bitfaster/BitFaster.Caching/wiki/ConcurrentLru), a lightweight pseudo LRU based on the [2Q](https://www.vldb.org/conf/1994/P439.PDF) eviction policy. Also with [time based eviction](https://github.com/bitfaster/BitFaster.Caching/wiki/ConcurrentLru:-Time%E2%80%90based-eviction).
- [ConcurrentLfu](https://github.com/bitfaster/BitFaster.Caching/wiki/ConcurrentLfu), an approximate LFU based on the [W-TinyLFU](https://arxiv.org/pdf/1512.00727.pdf) admission policy.
- Configurable [atomic valueFactory](https://github.com/bitfaster/BitFaster.Caching/wiki/Atomic-GetOrAdd) to mitigate [cache stampede](https://en.wikipedia.org/wiki/Cache_stampede).
- Configurable [thread-safe wrappers for IDisposable](https://github.com/bitfaster/BitFaster.Caching/wiki/IDisposable-and-Scoped-values) cache values.
- A [builder API](https://github.com/bitfaster/BitFaster.Caching/wiki/Cache-Builders) to easily configure cache features.
- [SingletonCache](https://github.com/bitfaster/BitFaster.Caching/wiki/SingletonCache) for caching single instance values, such as lock objects.
- High performance [concurrent counters](https://github.com/bitfaster/BitFaster.Caching/wiki/Metrics).
# Documentation
Please refer to the [wiki](https://github.com/bitfaster/BitFaster.Caching/wiki) for full API documentation, and a complete analysis of hit rate, latency and throughput.
# Getting started
BitFaster.Caching is installed from NuGet:
`dotnet add package BitFaster.Caching`
## ConcurrentLru
`ConcurrentLru` is a light weight drop in replacement for `ConcurrentDictionary`, but with bounded size enforced by the TU-Q eviction policy (derived from [2Q](https://www.vldb.org/conf/1994/P439.PDF)). There are no background threads, no global locks, concurrent throughput is high, lookups are fast and hit rate outperforms a pure LRU in all tested scenarios.
Choose a capacity and use just like `ConcurrentDictionary`, but with bounded size:
```csharp
int capacity = 128;
var lru = new ConcurrentLru(capacity);
var value = lru.GetOrAdd("key", (key) => new SomeItem(key));
```
## ConcurrentLfu
`ConcurrentLfu` is a drop in replacement for `ConcurrentDictionary`, but with bounded size enforced by the [W-TinyLFU eviction policy](https://arxiv.org/pdf/1512.00727.pdf). `ConcurrentLfu` has near optimal hit rate and high scalability. Reads and writes are buffered then replayed asynchronously to mitigate lock contention.
Choose a capacity and use just like `ConcurrentDictionary`, but with bounded size:
```csharp
int capacity = 128;
var lfu = new ConcurrentLfu(capacity);
var value = lfu.GetOrAdd("key", (key) => new SomeItem(key));
```