Shuttle.Hopper.Kafka 21.0.0-alpha

Prefix Reserved

This is a prerelease version of Shuttle.Hopper.Kafka.

dotnet add package Shuttle.Hopper.Kafka --version 21.0.0-alpha

NuGet\Install-Package Shuttle.Hopper.Kafka -Version 21.0.0-alpha

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="Shuttle.Hopper.Kafka" Version="21.0.0-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Shuttle.Hopper.Kafka" Version="21.0.0-alpha" />
                    

                            Directory.Packages.props

<PackageReference Include="Shuttle.Hopper.Kafka" />
                    

                            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 Shuttle.Hopper.Kafka --version 21.0.0-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Shuttle.Hopper.Kafka, 21.0.0-alpha"

#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 Shuttle.Hopper.Kafka@21.0.0-alpha

#: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=Shuttle.Hopper.Kafka&version=21.0.0-alpha&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Shuttle.Hopper.Kafka&version=21.0.0-alpha&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Kafka

PM> Install-Package Shuttle.Hopper.Kafka

Configuration

The URI structure is kafka://configuration-name/queue-name.

services.AddKafka(builder =>
{
    var kafkaOptions = new KafkaOptions
    {
        BootstrapServers = "localhost:9092",
        ReplicationFactor = 1,
        NumPartitions = 1,
        MessageSendMaxRetries = 3,
        RetryBackoff = TimeSpan.FromSeconds(1),
        EnableAutoCommit = false,
        EnableAutoOffsetStore = false,
        FlushEnqueue = false,
        UseCancellationToken = true,
        ConsumeTimeout = TimeSpan.FromSeconds(30),
        OperationTimeout = TimeSpan.FromSeconds(30),
        ConnectionsMaxIdle = TimeSpan.Zero,
        Acks = Acks.All,
        EnableIdempotence = true
    };

    kafkaOptions.ConfigureConsumer += (sender, args) =>
    {
        Console.WriteLine($"[event] : ConfigureConsumer / Uri = '{((IQueue)sender).Uri}'");
    };

    kafkaOptions.ConfigureProducer += (sender, args) =>
    {
        Console.WriteLine($"[event] : ConfigureProducer / Uri = '{((IQueue)sender).Uri}'");
    };

    builder.AddOptions("local", kafkaOptions);
});

The ConfigureConsumer event args arugment exposes the ConsumerConfig directly for any specific options that need to be set. Similarly, the ConfigureProducer event args arugment exposes the ProducerConfig.

The default JSON settings structure is as follows:

{
  "Shuttle": {
    "Kafka": {
      "local": {
        "BootstrapServers": "localhost:9092",
        "ReplicationFactor": 1,
        "NumPartitions": 1,
        "MessageSendMaxRetries": 3,
        "RetryBackoff": "00:00:01",
        "EnableAutoCommit": false,
        "EnableAutoOffsetStore": false,
        "FlushEnqueue": false,
        "UseCancellationToken": true,
        "ConsumeTimeout": "00:00:30",
        "OperationTimeout": "00:00:30",
        "ConnectionsMaxIdle": "00:00:00",
        "Acks": "All",
        "EnableIdempotence": true,
      }
    }
  }
}

Options

Option	Default	Description
`BootstrapServers`		Initial list of brokers as a CSV list of broker host or host:port.
`ReplicationFactor`	1	The replication factor for the new topic or -1 (the default) if a replica assignment is specified instead.
`NumPartitions`	1	The number of partitions for the new topic or -1 (the default) if a replica assignment is specified.
`MessageSendMaxRetries`	3	How many times to retry sending a failing Message. Note: retrying may cause reordering unless `enable.idempotence` is set to true.
`RetryBackoff`	"00:00:01"	The backoff time before retrying a protocol request.
`EnableAutoCommit`	false	Automatically and periodically commit offsets in the background.
`EnableAutoOffsetStore`	false	Automatically store offset of last message provided to application.
`FlushEnqueue`	false	If `true` will call `Flush` on the producer after a message has been enqueued.
`UseCancellationToken`	true	Indicates whether a cancellation token is used for relevant methods.
`ConsumeTimeout`	"00:00:30"	The duration to poll for messages before returning `null`, when the cancellation token is not used.
`OperationTimeout`	"00:00:30"	The duration to wait for relevant `async` methods to complete before timing out.
`ConnectionsMaxIdle`	"00:00:00"	Close broker connections after the specified time of inactivity.
`Acks`	"All"	This field indicates the number of acknowledgements the leader broker must receive from ISR brokers before responding to the request.
`EnableIdempotence`	true	When set to `true`, the producer will ensure that messages are successfully produced exactly once and in the original produce order.

Product	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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Confluent.Kafka (>= 2.12.0)
- Shuttle.Hopper (>= 21.0.0-alpha)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.