KafkaClient.NET
1.0.1
.NET 5.0
This package targets .NET 5.0. The package is compatible with this framework or higher.
.NET Core 3.1
This package targets .NET Core 3.1. The package is compatible with this framework or higher.
dotnet add package KafkaClient.NET --version 1.0.1
NuGet\Install-Package KafkaClient.NET -Version 1.0.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="KafkaClient.NET" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add KafkaClient.NET --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: KafkaClient.NET, 1.0.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 KafkaClient.NET as a Cake Addin #addin nuget:?package=KafkaClient.NET&version=1.0.1 // Install KafkaClient.NET as a Cake Tool #tool nuget:?package=KafkaClient.NET&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Kafka Client library for .NET Core
Library Version: v1.0.0
Installation
Install-Package KafkaClient.NET
Usage
KafkaClient.NET is a simple library to Produce and Consume easily in .NET Core applications. It is a wrapper on official Confluent.Kafka client library. It supports simple objects and Protocolbuffer objects.
Setup DI
var serviceProvider = new ServiceCollection()
.AddLogging(loggingBuilder =>
{
loggingBuilder.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);
})
.AddKafka(options =>
{
options.BootstrapServers = "10.1.1.1:9092"; // replace with yours
})
.BuildServiceProvider();
.BuildServiceProvider();
Get Kafka Service instance
var kafka = serviceProvider.GetRequiredService<IKafkaService>();
Simple Producer Example
Create producer object
var p1 = kafka.CreateProducer<Null, string>(options =>
{
options.TopicName = "test-topic-01";
});
Produce message
var dr = p1.ProduceAsync(new Message<Null, string> { Value = "test" }).Result;
Console.WriteLine($"Delivered '{dr.Value}' to '{dr.TopicPartitionOffset}'");
Simple Consumer Example
Create consumer object
var c1 = kafka.CreateConsumer<Null, string>(options =>
{
options.TopicName = "test-topic-02";
options.GroupId = "1";
options.ThreadCount = 8;
});
Start consuming
c1.StartConsumer(MessageReceived);
Stop consuming
c1.StopConsumer();
Producer Example with protobuf
Create producer object
var p2 = kafka.CreateProducerProtobuf<string, User>(options =>
{
options.TopicName = "test-topic-03";
options.SchemaRegistryUrl = "10.1.1.1:8081"; // replace with yours
});
Produce message
User user = new User { Name = "Imran Khan", FavoriteColor = "green", FavoriteNumber = 100 };
var dr = p2.ProduceAsync(new Message<string, User> { Key = user.Name, Value = user }).Result;
Console.WriteLine($"Delivered '{dr.Value}' to '{dr.TopicPartitionOffset}'");
Consumer Example with protobuf
Create consumer object
var c2 = kafka.CreateConsumerProtobuf<string, User>(options =>
{
options.TopicName = "test-topic-03";
options.GroupId = "30";
options.ThreadCount = 1;
options.AutoOffsetReset = AutoOffsetReset.Earliest;
});
Start consuming
c2.StartConsumer(MessageReceived);
Stop consuming
c2.StopConsumer();
License
This library licensed under the MIT license.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. 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. 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. |
.NET Core | netcoreapp3.1 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETCoreApp 3.1
- Confluent.Kafka (>= 1.8.2)
- Confluent.SchemaRegistry.Serdes.Protobuf (>= 1.8.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 3.1.20)
- Microsoft.Extensions.Logging.Abstractions (>= 3.1.20)
- Microsoft.Extensions.Options (>= 3.1.20)
-
net5.0
- Confluent.Kafka (>= 1.8.2)
- Confluent.SchemaRegistry.Serdes.Protobuf (>= 1.8.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 5.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 5.0.0)
- Microsoft.Extensions.Options (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
added support for .net5.0