Class KafkaConsumer

Consumes an endpoint and invokes a callback delegate when a message is received.

Inheritance
object
Consumer
Consumer<KafkaBroker, KafkaConsumerEndpoint, KafkaOffset>
KafkaConsumer
Implements
Inherited Members
Namespace: Silverback.Messaging.Broker
Assembly: Silverback.Integration.Kafka.dll
Syntax
public class KafkaConsumer : Consumer<KafkaBroker, KafkaConsumerEndpoint, KafkaOffset>, IConsumer, IDisposable

Constructors

| Improve this doc View source

KafkaConsumer(KafkaBroker, KafkaConsumerEndpoint, IBrokerBehaviorsProvider<IConsumerBehavior>, IConfluentConsumerBuilder, IBrokerCallbacksInvoker, IServiceProvider, IInboundLogger<KafkaConsumer>)

Initializes a new instance of the KafkaConsumer class.

Declaration
public KafkaConsumer(KafkaBroker broker, KafkaConsumerEndpoint endpoint, IBrokerBehaviorsProvider<IConsumerBehavior> behaviorsProvider, IConfluentConsumerBuilder confluentConsumerBuilder, IBrokerCallbacksInvoker callbacksInvoker, IServiceProvider serviceProvider, IInboundLogger<KafkaConsumer> logger)
Parameters
Type Name Description
KafkaBroker broker

The IBroker that is instantiating the consumer.
KafkaConsumerEndpoint endpoint

The endpoint to be consumed.
IBrokerBehaviorsProvider<IConsumerBehavior> behaviorsProvider

The IBrokerBehaviorsProvider<TBehavior>.
IConfluentConsumerBuilder confluentConsumerBuilder

The IConfluentConsumerBuilder.
IBrokerCallbacksInvoker callbacksInvoker

The IBrokerCallbacksInvoker.
IServiceProvider serviceProvider

The IServiceProvider to be used to resolve the needed services.
IInboundLogger<KafkaConsumer> logger

The IInboundLogger<TCategoryName>.

Properties

| Improve this doc View source

MemberId

Gets the (dynamic) group member id of this consumer (as set by the broker).

Declaration
public string MemberId { get; }
Property Value
Type Description
string

Methods

| Improve this doc View source

CommitCoreAsync(IReadOnlyCollection<KafkaOffset>)

Commits the specified messages sending the acknowledgement to the message broker.

Declaration
protected override Task CommitCoreAsync(IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers)
Parameters
Type Name Description
IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers

The identifiers of to message be committed.
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides
| Improve this doc View source

ConnectCoreAsync()

Connects to the message broker.

Declaration
protected override Task ConnectCoreAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides
| Improve this doc View source

DisconnectCoreAsync()

Disconnects from the message broker.

Declaration
protected override Task DisconnectCoreAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides
| Improve this doc View source

GetCurrentSequenceStores()

Gets the ISequenceStore instances used by this consumer. Some brokers will require multiple stores (e.g. the KafkaConsumer will create a store per each assigned partition).

Declaration
public override IReadOnlyList<ISequenceStore> GetCurrentSequenceStores()
Returns
Type Description
IReadOnlyList<ISequenceStore>

The list of ISequenceStore.
Overrides
Remarks

Used only for testing and maintained to preserve backward compatibility.

| Improve this doc View source

RollbackCoreAsync(IReadOnlyCollection<KafkaOffset>)

If necessary notifies the message broker that the specified messages couldn't be processed successfully, to ensure that they will be consumed again.

Declaration
protected override Task RollbackCoreAsync(IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers)
Parameters
Type Name Description
IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers

The identifiers of to message be rolled back.
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides
| Improve this doc View source

StartCoreAsync()

Starts consuming. Called to resume consuming after StopAsync() has been called.

Declaration
protected override Task StartCoreAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides
| Improve this doc View source

StopCoreAsync()

Stops consuming while staying connected to the message broker.

Declaration
protected override Task StopCoreAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides
| Improve this doc View source

WaitUntilConsumingStoppedCoreAsync()

Waits until the consuming is stopped.

Declaration
protected override Task WaitUntilConsumingStoppedCoreAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides

Implements