Franz.Common.Messaging.Hosting.Kafka
3.0.0
dotnet add package Franz.Common.Messaging.Hosting.Kafka --version 3.0.0
NuGet\Install-Package Franz.Common.Messaging.Hosting.Kafka -Version 3.0.0
<PackageReference Include="Franz.Common.Messaging.Hosting.Kafka" Version="3.0.0" />
<PackageVersion Include="Franz.Common.Messaging.Hosting.Kafka" Version="3.0.0" />
<PackageReference Include="Franz.Common.Messaging.Hosting.Kafka" />
paket add Franz.Common.Messaging.Hosting.Kafka --version 3.0.0
#r "nuget: Franz.Common.Messaging.Hosting.Kafka, 3.0.0"
#:package Franz.Common.Messaging.Hosting.Kafka@3.0.0
#addin nuget:?package=Franz.Common.Messaging.Hosting.Kafka&version=3.0.0
#tool nuget:?package=Franz.Common.Messaging.Hosting.Kafka&version=3.0.0
Franz.Common.Messaging.Hosting.Kafka
BackgroundService integration for Kafka message consumption and outbox polling.
Overview
This package owns the Kafka listener's hosted-service lifecycle. It is separate from Franz.Common.Messaging.Kafka, which configures the Kafka producer, consumer, admin client, topics, and transport services.
Installation
dotnet add package Franz.Common.Messaging.Hosting.Kafka
Kafka listener
First register the Kafka transport:
using Franz.Common.Messaging.Kafka.Extensions;
using Franz.Common.Messaging.Hosting.Kafka;
builder.Services.AddKafkaMessaging(builder.Configuration);
builder.Services.AddKafkaHostedListener(options =>
{
// Optional overrides for KafkaMessagingOptions.
options.Consumer.ConcurrencyLevel = 4;
});
AddKafkaHostedListener accepts an Action<KafkaMessagingOptions>, not an IConfiguration argument. The transport options are normally bound from Messaging:Kafka by AddKafkaMessaging(configuration); the callback applies explicit DI configuration overrides.
The listener runs under KafkaMessagingHostedService : BackgroundService. Startup validates required tenant messaging services when TenantMessagingOptions.RequireTenantScope is enabled. Message handling occurs in a separate DI scope per delivery.
Outbox listener
builder.Services.AddOutboxHostedListener(options =>
{
options.Enabled = true;
options.BatchSize = 100;
});
This registers OutboxMessageListener and its hosted service. Configure the required IMessageStore, IInboxStore, dispatcher, and serializer through the application's selected persistence and messaging packages.
Tenant processing
Register Franz.Common.Messaging.MultiTenancy and enable RequireTenantScope when the consumer processes tenant-owned data. Provide the tenant store and a producer authorizer based on trusted transport identity.
License
MIT. See the repository LICENSE.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. |
-
net10.0
- Franz.Common.Messaging.Hosting (>= 3.0.0)
- Franz.Common.Messaging.Kafka (>= 3.0.0)
- Franz.Common.Messaging.MultiTenancy (>= 3.0.0)
- SharpCompress (>= 0.50.7)
- Snappier (>= 1.3.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Franz.Common.Messaging.Hosting.Kafka:
| Package | Downloads |
|---|---|
|
Franz.Common.Http.Messaging
Shared utility library for the Franz Framework. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 3.0.0 | 103 | 11/10/2026 |
| 2.3.4 | 351 | 11/1/2026 |
| 2.3.3 | 261 | 10/28/2026 |
| 2.3.2 | 119 | 10/27/2026 |
| 2.3.1 | 113 | 10/26/2026 |
| 2.3.0 | 158 | 7/21/2026 |
| 2.2.19 | 142 | 7/19/2026 |
| 2.2.18 | 138 | 7/19/2026 |
| 2.2.17 | 145 | 7/12/2026 |
| 2.2.16 | 146 | 7/2/2026 |
| 2.2.15 | 151 | 6/29/2026 |
| 2.2.14 | 145 | 6/29/2026 |
| 2.2.13 | 147 | 6/29/2026 |
| 2.2.12 | 140 | 6/28/2026 |
| 2.2.11 | 149 | 6/28/2026 |
| 2.2.10 | 142 | 6/28/2026 |
| 2.2.9 | 145 | 6/28/2026 |
| 2.2.8 | 138 | 6/28/2026 |
| 2.2.7 | 150 | 6/7/2026 |
| 2.2.6 | 147 | 6/6/2026 |