Hangfire.InMemory 0.9.0
Hangfire.InMemory
This is an efficient implementation of in-memory job storage for Hangfire with data structures close to their optimal representation.
The goal of this storage is to provide developers a fast path to start using Hangfire without setting up any additional infrastructure like SQL Server or Redis, with the possibility of swapping implementation in the production environment. The non-goal of this implementation is to compete with TPL or other in-memory processing libraries – serialization alone adds a significant overhead.
This implementation uses proper synchronization, and everything, including locks, queues, or queries, is implemented as blocking operations, so there's no active polling in these cases. Read and write queries are processed by a dedicated background thread to avoid additional synchronization between threads, trying to keep everything as simple as possible with the future async-based implementation in mind. The internal state uses SortedDictionary, SortedSet, and LinkedList data structures to avoid getting even huge collections to the Large Object Heap, reducing the potential OutOfMemoryException-related issues due to memory fragmentation.
This storage also uses a monotonic clock whenever possible by leveraging the Stopwatch.GetTimestamp method. So, expiration rules don't break when the clock suddenly jumps to the future or the past due to synchronization issues or manual updates.
Requirements
Minimal supported version of Hangfire is 1.8.0. Latest version that supports previous versions of Hangfire is Hangfire.InMemory 0.3.7.
Installation
Hangfire.InMemory is available on NuGet, so we can install it, as usual, using our favorite package manager.
> dotnet add package Hangfire.InMemory
Configuration
After the package is installed, we can use the new UseInMemoryStorage method for the IGlobalConfiguration interface to register the storage.
GlobalConfiguration.Configuration.UseInMemoryStorage();
Maximum Expiration Time
Starting from version 0.7.0, the package controls the maximum expiration time for storage entries and sets it to 3 hours by default when a higher expiration time is passed. For example, the default expiration time for background jobs is 24 hours, and for batch jobs and their contents, the default time is 7 days, which can be too big for in-memory storage that runs side-by-side with the application.
We can control this behavior or even turn it off with the MaxExpirationTime option available in the InMemoryStorageOptions class in the following way:
GlobalConfiguration.Configuration.UseInMemoryStorage(new InMemoryStorageOptions
{
MaxExpirationTime = TimeSpan.FromHours(3) // Default value, we can also set it to `null` to disable.
});
It is also possible to use TimeSpan.Zero as a value for this option. In this case, entries will be removed immediately instead of relying on the time-based eviction implementation. Please note that some unwanted side effects may appear when using low value – for example, an antecedent background job may be created, processed, and expired before its continuation is created, resulting in exceptions.
Comparing Keys
Different storages use different rules for comparing keys. Some of them, like Redis, use case-sensitive comparisons, while others, like SQL Server, may use case-insensitive comparison implementation. It is possible to set this behavior explicitly and simplify moving to another storage implementation in a production environment by configuring the StringComparer option in the InMemoryStorageOptions class in the following way:
GlobalConfiguration.Configuration.UseInMemoryStorage(new InMemoryStorageOptions
{
StringComparer = StringComparer.Ordinal; // Default value, case-sensitive.
});