Hangfire.InMemory 0.8.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Hangfire.InMemory --version 0.8.1
NuGet\Install-Package Hangfire.InMemory -Version 0.8.1
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="Hangfire.InMemory" Version="0.8.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Hangfire.InMemory --version 0.8.1
#r "nuget: Hangfire.InMemory, 0.8.1"
#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.
// Install Hangfire.InMemory as a Cake Addin
#addin nuget:?package=Hangfire.InMemory&version=0.8.1

// Install Hangfire.InMemory as a Cake Tool
#tool nuget:?package=Hangfire.InMemory&version=0.8.1

Hangfire.InMemory

Build status

This is an attempt to create an efficient transactional in-memory storage for Hangfire with data structures close to their optimal representation. The result of this attempt should enable production-ready usage of this storage implementation and handle particular properties of in-memory processing like avoiding OutOfMemoryException at any cost and moderate load on garbage collection. Of course we can't avoid them entirely, but at least can control them somehow.

Read and write queries are processed by a single thread to avoid additional synchronization between threads and keep everything as simple as possible (keeping future async-based implementation in mind). Monitoring API also uses that dedicated thread, but its future implementation can be changed by using concurrent data structures and immutability, but I expect this will increase load on garbage collection.

Distributed locks (heh, in an in-process storage), queue fetch logic (even from multiple queues) and transactional queries are implemented as blocking operations, so there is no active polling in these cases. Every data returned by storage can be safely changed without causing underlying storage state to be changed with bypassing required transactional processing logic, so everything is safe (but increase load on GC). Every data structure, including indexes and their records, is removed when empty to avoid memory leaks.

TODO

  • Control OutOfMemoryException by providing some kind of limits which can be established easily, e.g. total number of jobs.
  • Avoid unnecessary object allocations without sacrificing the safety property (as described above).
  • Add integration (for public API) and unit tests (for internal API).
  • Force expiration when memory pressure is high to avoid OutOfMemoryException.
  • Add overridden default for expiration time for jobs and batches?
  • Can avoid synchronization in some read-only methods in the MemoryConnectionclass.
  • Avoid using large object heap at any cost by large collections – millions of jobs can be created.

Installation

Hangfire.InMemory is available on NuGet so we can install it as usual using your 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 2 hours when a higher expiration time is passed. By default, the expiration time for background jobs is 24 hours, and for batch jobs and their contents 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 disable it with the MaxExpirationTime option available in the InMemoryStorageOptions class in the following way.

GlobalConfiguration.Configuration.UseInMemoryStorage(new InMemoryStorageOptions
{
    MaxExpirationTime = TimeSpan.FromHours(6) // Or set to `null` to disable
});
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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. 
.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 net451 is compatible.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  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 (11)

Showing the top 5 NuGet packages that depend on Hangfire.InMemory:

Package Downloads
Mesawer.InfrastructureLayer

This library contains all the required reusable components in the infrastructure layer.

Eaf.HangFire.AspNetCore The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Enterprise Application Foundation - AspNetCore -HangFire

Axelius

Package Description

SimpleIdServer.IdServer

Identity server project with OPENID, OAUTH2.0, UMA2.0, CIBA and FAPI support.

OTAL.DiscordBot

Library for OTAL members to make Discord Bots

GitHub repositories (8)

Showing the top 5 popular GitHub repositories that depend on Hangfire.InMemory:

Repository Stars
Kareadita/Kavita
Kavita is a fast, feature rich, cross platform reading server. Built with the goal of being a full solution for all your reading needs. Setup your own server and share your reading collection with your friends and family.
fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat
可能是全网最完整的 C# 版微信 SDK,封装全部已知的微信 API,包含微信公众平台(订阅号+服务号+小程序+小游戏+小商店+视频号)、微信开放平台、微信商户平台(微信支付+微企付)、企业微信、微信广告平台、微信智能对话开放平台等模块,可跨平台。持续随官方更新,欢迎 Star/Fork/PR。QQ 交流群 875580418【满】、930461548【满】、611974621。
neozhu/CleanArchitectureWithBlazorServer
This is a repository for creating a Blazor Server dashboard application following the principles of Clean Architecture
simpleidserver/SimpleIdServer
OpenID, OAuth 2.0, SCIM2.0, UMA2.0, FAPI, CIBA & OPENBANKING Framework for ASP.NET Core
yuzd/Hangfire.HttpJob
httpjob for Hangfire,restful api for Hangfire,job调度与业务分离
Version Downloads Last updated
0.10.3 313 6/17/2024
0.10.2 167 6/17/2024
0.10.0 8,147 6/3/2024
0.9.0 48,662 4/23/2024
0.8.1 117,150 3/21/2024
0.8.0 86,577 2/16/2024
0.7.0 119,813 1/10/2024
0.6.0 210,991 10/23/2023
0.5.1 317,966 6/28/2023
0.5.0 4,434 6/27/2023
0.4.1 109,426 5/24/2023
0.4.0 137,468 4/28/2023
0.3.7 121,827 3/22/2023
0.3.6 176,878 2/8/2023
0.3.5 217,991 11/25/2022
0.3.4 1,590,345 11/6/2020
0.3.3 480 11/6/2020
0.3.2 518 10/29/2020
0.3.1 539 10/22/2020
0.3.0 562 10/22/2020
0.2.0 639 10/12/2020
0.1.0 1,870 9/29/2020

https://github.com/HangfireIO/Hangfire.InMemory/releases

0.8.1
• Fixed – Incorrect validation in the `MaxStateHistoryLength` setter (by @DPschichholz).

0.8.0
• Project – Sign NuGet package and .NET assemblies on build with a company's own certificate.
• Project – Require package signature validation when restoring dependencies.
• Project – Add HangfireIO as an owner for the NuGet package.
• Project – Add readme file and icon to the NuGet package.
• Project – Fix Git repository URL in the NuGet package metadata.

0.7.0
• Added – `InMemoryStorageOptions.MaxExpirationTime` option to control the maximum expiration time.
• Changed – The default value for maximum expiration time is 2 hours now, not days.
• Fixed – Populate `ParametersSnapshot` and `InvocationData` properties in `IMonitoringApi.JobDetails`.
• Fixed – The "Awaiting Jobs" page now includes the state name of an antecedent background job.
• Fixed – The "Scheduled Jobs" page now has correct identifiers for jobs with explicit queues defined.
• Fixed – Unify job ordering in Monitoring API to be the same as in other storages.
• Project – Enable source link support with embedded symbols for simplified debugging.
• Project – Refactored internals and added even more unit tests.
• Project – Enable NuGet package restore with lock file and locked mode.
• Project – Project and Release Notes URLs in the NuGet package now point to the repository.
• Project – Enable tests running on the `net6.0` platform and Ubuntu on AppVeyor.

0.6.0
• Added – `InMemoryStorageOptions.MaxStateHistoryLength` option to control state entries.
• Changed – Always use monotonic clock when working with time.
• Changed – Release distributed locks when their connection is disposed.
• Changed – Pass dispatcher fault exceptions to a caller thread.
• Project – Refactor internal types to have a cleaner project structure and avoid mistakes.
• Project – Enable static analysis by the Microsoft.CodeAnalysis.NetAnalyzers package.
• Project – Enable portable PDBs for the .NET Framework 4.5.1 platform.

0.5.1
• Fixed – Infinite loop in recurring job scheduler consuming 100% CPU regression after 0.5.0.

0.5.0
• Added – `InMemoryStorageOptions.StringComparer` as a central option for key and index comparisons.

0.4.1
• Fixed – "Awaiting Jobs" metric is now correctly populated with `Version180` compatibility level.

0.4.0
• Breaking – Package now depends on Hangfire.Core version 1.8.0.
• Breaking – Replace the `net45` target with `net451` one as the former is not supported.

• Changed – Improve `GetFirstByLowestScoreFromSet` operations.
• Changed – Implement the `Job.Queue` feature.
• Changed – Implement the `Connection.GetUtcDateTime` feature.
• Changed – Implement the `Connection.GetSetContains` feature.
• Changed – Implement the `Connection.GetSetCount.Limited` feature.
• Changed – Implement the `Connection.BatchedGetFirstByLowestScoreFromSet` feature for the storage.
• Changed – Implement the `Transaction.AcquireDistributedLock` feature.
• Changed – Implement the `Transaction.CreateJob` feature.
• Changed – Implement the `Transaction.SetJobParameter` feature.
• Changed – Implement the new monitoring features.
• Changed – Populate the new properties in Monitoring API.
• Changed – Populate the `Retries` metric in the `GetStatistics` method.

0.3.7
• Fixed – Throw `BackgroundJobServerGoneException` outside of dispatcher thread.

0.3.6
• Fixed – Ensure lock entries are eventually removed from their collection.
• Fixed – Ensure lock entries are always updated under a monitor.

0.3.5
• Fixed – Ensure entries are expired even during constant storage pressure.

0.3.4
• Fixed – Reverse state list instead of sorting it by date in the `JobDetails` method.
• Fixed – Better sorting for state indexes, take into account job creation date.
• Fixed – Reverse succeeded and deleted job lists to match Redis implementation.

0.3.3
• Fixed – Sort queues and servers when returning them from monitoring api and in the Dashboard UI.

0.3.2
• Fixed – Enqueued jobs may become invisible when adding a lot of jobs simultaneously to a new queue.
• Fixed – Some workers are waiting for background jobs forever when several jobs added at once.
• Fixed – Workers are able to detect new background jobs only after another background job is processed.
• Fixed – Workers don't see background jobs when multiple queues are used with minimal workload.

0.3.1
• Fixed – `NullReferenceException` in the `SignalOneQueueWaitNode` method when using multiple queues.

0.3.0
• Added – `InMemoryStorageOptions.DisableJobSerialization` option.
• Fixed – `ObjectDisposedException` on semaphore when committing a transaction.
• Fixed – Gracefully handle `ObjectDisposedException` when signaling for query completion.
• Fixed – Avoid killing the whole process in case of an exception in dispatcher, stop it instead.
• Project – Add a lot of new unit tests for `InMemoryMonitoringApi` class.

0.2.0
• Fixed – A lot of corner cases revealed by unit tests.
• Project – Added a ton of unit tests for the top-level classes to ensure behavior is consistent.

0.1.0 – Initial release