Itmo.Dev.Platform.Kafka 1.0.70

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Itmo.Dev.Platform.Kafka --version 1.0.70

NuGet\Install-Package Itmo.Dev.Platform.Kafka -Version 1.0.70

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="Itmo.Dev.Platform.Kafka" Version="1.0.70" />

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

paket add Itmo.Dev.Platform.Kafka --version 1.0.70

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

#r "nuget: Itmo.Dev.Platform.Kafka, 1.0.70"

#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 Itmo.Dev.Platform.Kafka as a Cake Addin
#addin nuget:?package=Itmo.Dev.Platform.Kafka&version=1.0.70

// Install Itmo.Dev.Platform.Kafka as a Cake Tool
#tool nuget:?package=Itmo.Dev.Platform.Kafka&version=1.0.70

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

Itmo.Dev.Platform.Kafka

Platform extensions for working with Kafka

Consumer

Implement message handler

public class MyMessageHandler : IKafkaMessageHandler<int, string>
{
    public ValueTask HandleAsync(
        IEnumerable<ConsumerKafkaMessage<TKey, TValue>> messages, 
        CancellationToken cancellationToken)
    {
        foreach (var message in messages)
        {
            Console.WriteLine($"Received message, Key = {message.Key}, Value = {message.Value}");
        }
        
        return ValueTask.CompletedTask;
    }
}

Implement configuration type

public class Configuration : IKafkaConsumerConfiguration
{
    public bool IsDisabled { get; init; }

    public TimeSpan DisabledConsumerTimeout { get; init; }

    public string Host { get; set; } = string.Empty;

    public string Topic { get; init; } = string.Empty;

    public string Group { get; init; } = string.Empty;

    public int ParallelismDegree { get; init; }

    public int BufferSize { get; init; }

    public TimeSpan BufferWaitLimit { get; init; }

    public bool ReadLatest { get; init; }
}

At runtime, configuration would be received as IOptionsMonitor<TConfiguration>, so you should manually register it to DI container as options.

Add consumer to your ASP.NET server services

Consumer requires an ASP.NET host, as it is implemented as hosted service

Use extension methods to register your consumer.

collection.AddKafkaConsumer<int, string>(builder => builder
    .HandleWith<MyMessageHandler>()
    .DeserializeKeyWithNewtonsoft()
    .DeserializeValueWithNewtonsoft()
    .UseConfiguration<Configuration>());

If you want to use custom deserializer, you can call DeserializeKeyWith<T> where T : IDeserializer<T> method, same way with value deserialization.

If your topic model is defined as protobuf, you can call DeserializeKeyWithProto extension method, same way with value deserialization.

Producer

Add producer to your service collection

collection.AddKafkaProducer<int, string>(builder => builder
    .SerializeKeyWithNewtonsoft()
    .SerializeValueWithNewtonsoft()
    .UseConfiguration<Configuration>());

You can use protobuf serialization same way as it is with consumer.

Resolve producer instance from service provider

var producer = provider.GetRequiredService<IKafkaMessageProducer<int, string>>();
await producer.ProduceAsync(messages, default);

Product	Compatible and additional computed target framework versions.
.NET	net7.0 is compatible. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net7.0
- Confluent.Kafka (>= 2.2.0)
- Google.Protobuf (>= 3.23.4)
- Itmo.Dev.Platform.Common (>= 1.1.70)
- Microsoft.Extensions.Hosting (>= 7.0.1)
- Microsoft.Extensions.Options (>= 7.0.1)
- Newtonsoft.Json (>= 13.0.3)
- Serilog (>= 3.0.1)
- System.Linq.Async (>= 6.0.1)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
2.2.228	64	10/31/2024
2.2.206	95	10/30/2024
2.2.204	73	10/29/2024
2.2.202	64	10/29/2024
2.1.196	63	10/29/2024
2.1.193	68	10/29/2024
2.1.190	71	10/26/2024
2.0.174	69	10/25/2024
2.0.133	63	10/25/2024
2.0.132	64	10/24/2024
2.0.131	79	10/24/2024
2.0.130	62	10/24/2024
2.0.129	68	10/24/2024
2.0.128	70	10/24/2024
2.0.127	65	10/23/2024
2.0.126	73	10/11/2024
2.0.125	71	10/11/2024
2.0.124	66	10/11/2024
2.0.123	67	10/11/2024
2.0.122	71	10/11/2024
2.0.121	71	10/11/2024
2.0.120	75	10/11/2024
2.0.119	72	10/11/2024
2.0.118	81	10/11/2024
2.0.117	74	10/10/2024
2.0.115	76	10/10/2024
2.0.113	72	10/6/2024
2.0.112	127	8/22/2024
2.0.111	138	5/14/2024
2.0.110	109	5/13/2024
2.0.109	104	5/13/2024
2.0.108	125	5/6/2024
2.0.107	106	5/6/2024
2.0.106	107	5/6/2024
2.0.105	107	5/4/2024
2.0.102	114	5/4/2024
2.0.101	104	4/26/2024
2.0.100	118	4/22/2024
2.0.99	106	4/21/2024
2.0.98	107	4/21/2024
2.0.97	101	4/19/2024
2.0.96	104	4/18/2024
2.0.95	101	4/18/2024
2.0.94	124	2/13/2024
2.0.93	116	2/10/2024
2.0.91	97	2/10/2024
2.0.90	112	2/10/2024
2.0.89	255	2/3/2024
2.0.86	102	2/1/2024
1.1.85	104	1/30/2024
1.1.83	151	1/27/2024
1.1.82	191	1/5/2024
1.1.81	277	1/3/2024
1.0.80	141	12/30/2023
1.0.79	119	12/30/2023
1.0.78	124	12/30/2023
1.0.77	134	12/28/2023
1.0.76	121	12/27/2023
1.0.75	157	12/9/2023
1.0.73	159	11/30/2023
1.0.72	139	11/27/2023
1.0.71	138	11/27/2023
1.0.70	127	11/27/2023
1.0.69	109	11/27/2023
1.0.67	141	11/25/2023
1.0.66	128	11/25/2023
1.0.65	130	11/23/2023
1.0.64	122	11/23/2023
1.0.62	126	11/18/2023
1.0.61	130	11/18/2023
1.0.60	115	11/17/2023
1.0.59	119	11/16/2023
1.0.58	115	11/13/2023
1.0.57	106	11/12/2023
1.0.56	117	11/12/2023
1.0.54	120	11/7/2023
1.0.53	124	11/4/2023
1.0.52	151	10/29/2023
1.0.51	134	10/29/2023
1.0.50	142	10/29/2023
1.0.48	126	10/29/2023

Added options post configure