Bsft.Outbox 2.2.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Bsft.Outbox --version 2.2.0
                    


                    

                
NuGet\Install-Package Bsft.Outbox -Version 2.2.0
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="Bsft.Outbox" Version="2.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Bsft.Outbox" Version="2.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Bsft.Outbox" />
                    


                            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 Bsft.Outbox --version 2.2.0
                    


                    

                
#r "nuget: Bsft.Outbox, 2.2.0"
#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. 
#:package Bsft.Outbox@2.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Bsft.Outbox&version=2.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Bsft.Outbox&version=2.2.0
                    


                            Install as a Cake Tool

Bsft.Outbox

The drain kernel every transactional outbox in a host shares: lease a batch, apply each row's side effect, mark what succeeded, hold back what failed and retire what keeps failing.

Install

dotnet add package Bsft.Outbox

Requires Bsft.Outbox.Abstractions (pulled transitively) and Bsft.Core. A store implementation comes from Bsft.Outbox.EFCore or from the host.

Register

services.AddBsftOutbox<MyPayload>("my-outbox", options =>
{
    options.BatchSize = 50;
});

The store and the side effect stay the owning package's to register: which rows this outbox holds and what they mean are the two things the kernel cannot guess. Run the drainer with Bsft.Core.Polling.PollLoop from a hosted service of your own, or drain on demand through IOutboxDrainer<TPayload>.

Configure

Every outbox is a named options instance, bound from Bsft:Outbox:Instances:<name> when the registration is handed an IConfiguration:

services.AddBsftOutbox<MyPayload>("my-outbox", builder.Configuration);

{ "Bsft": { "Outbox": { "Instances": { "my-outbox": { "BatchSize": 50 } } } } }

The action overload still applies, and when both are used the action runs after the section.

Option Default Effect
BsftOutboxOptions.PollInterval 00:00:05 How long a loop waits after a pass that found nothing. Must be positive.
BsftOutboxOptions.BatchSize 100 The most rows one pass claims. Must be at least 1.
BsftOutboxOptions.LeaseDuration 00:01:00 How long a claim holds. Must be positive, and has to cover a whole batch.
BsftOutboxOptions.MaxDeliveryAttempts 10 How often a row may fail before it is retired. Must be at least 1.
BsftOutboxOptions.RetryBackoff 00:00:05 The first interval a failed row waits; doubles per attempt. Must not be negative.
BsftOutboxOptions.MaxRetryDelay 00:05:00 The ceiling of the schedule and the clamp on what a failure may ask for. Must be positive.

Validation: the host is refused at start, naming the outbox, the option and the value it was given. The drainer's constructor asks the same rules again, for a caller that builds one without the options pipeline.

Extend

IOutboxSideEffect<TPayload> (what a row means, applied before the row is marked; there is no default — the owning package writes one). IOutboxStore<TPayload> (where the rows live; Bsft.Outbox.EFCore implements the lease protocol once). IOutboxRetrySchedule (how long a failed row waits; the shipped one is exponential with jitter and honours IRetryAfter as a floor).

Documentation

Topic page: docs/outbox.md. Conventions: docs/package-conventions.md.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Bsft.Outbox:

Package Downloads
Bsft.Messaging

BSFT Framework messaging: in-memory message bus, integration event staging and the transactional outbox dispatcher.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.2.0 129 10/23/2026
2.1.0 155 9/28/2026