Table of Contents

Class DispatchBuilderKafkaExtensions

Namespace
Microsoft.Extensions.DependencyInjection
Assembly
Excalibur.Dispatch.Transport.Kafka.dll

Extension methods for configuring Kafka transport via IDispatchBuilder.

public static class DispatchBuilderKafkaExtensions
Inheritance
DispatchBuilderKafkaExtensions
Inherited Members

Methods

UseKafka(IDispatchBuilder, Action<IKafkaTransportBuilder>)

Configures the Kafka transport with the default name via the dispatch builder.

[RequiresUnreferencedCode("Kafka transport uses reflection for schema registry and serialization")]
[RequiresDynamicCode("Kafka transport uses runtime code generation for schema registry and serialization")]
public static IDispatchBuilder UseKafka(this IDispatchBuilder builder, Action<IKafkaTransportBuilder> configure)

Parameters

builder IDispatchBuilder

The dispatch builder.

configure Action<IKafkaTransportBuilder>

The transport configuration action.

Returns

IDispatchBuilder

The builder for fluent chaining.

Examples

services.AddDispatch(dispatch =>
{
    dispatch.UseKafka(kafka =>
    {
        kafka.BootstrapServers("localhost:9092")
             .ConfigureConsumer(consumer => consumer.GroupId("my-group"));
    });
});

Exceptions

ArgumentNullException

Thrown when builder or configure is null.

UseKafka(IDispatchBuilder, string, Action<IKafkaTransportBuilder>)

Configures a named Kafka transport via the dispatch builder.

[RequiresUnreferencedCode("Kafka transport uses reflection for schema registry and serialization")]
[RequiresDynamicCode("Kafka transport uses runtime code generation for schema registry and serialization")]
public static IDispatchBuilder UseKafka(this IDispatchBuilder builder, string name, Action<IKafkaTransportBuilder> configure)

Parameters

builder IDispatchBuilder

The dispatch builder.

name string

The transport name for multi-transport scenarios.

configure Action<IKafkaTransportBuilder>

The transport configuration action.

Returns

IDispatchBuilder

The builder for fluent chaining.

Examples

services.AddDispatch(dispatch =>
{
    dispatch.UseKafka("analytics", kafka =>
    {
        kafka.BootstrapServers("analytics-cluster:9092")
             .MapTopic<MetricEvent>("metrics-topic");
    });
});

Exceptions

ArgumentNullException

Thrown when builder or configure is null.

ArgumentException

Thrown when name is null or whitespace.