Class KafkaConsumer

Inheritance
System.Object
Consumer
Consumer<KafkaBroker, KafkaConsumerEndpoint, KafkaOffset>
KafkaConsumer
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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.
System.IServiceProvider serviceProvider

The System.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
System.String

Methods

| Improve this doc View source

CommitCoreAsync(IReadOnlyCollection<KafkaOffset>)

Declaration
protected override Task CommitCoreAsync(IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Silverback.Messaging.Broker.Consumer<Silverback.Messaging.Broker.KafkaBroker, Silverback.Messaging.KafkaConsumerEndpoint, Silverback.Messaging.Broker.KafkaOffset>.CommitCoreAsync(System.Collections.Generic.IReadOnlyCollection<Silverback.Messaging.Broker.KafkaOffset>)
| Improve this doc View source

ConnectCoreAsync()

Declaration
protected override Task ConnectCoreAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
| Improve this doc View source

DisconnectCoreAsync()

Declaration
protected override Task DisconnectCoreAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
| Improve this doc View source

GetCurrentSequenceStores()

Declaration
public override IReadOnlyList<ISequenceStore> GetCurrentSequenceStores()
Returns
Type Description
System.Collections.Generic.IReadOnlyList<ISequenceStore>
Overrides
| Improve this doc View source

GetOffsetsForTimestamp(IEnumerable<TopicPartitionTimestamp>, TimeSpan)

Look up the offsets for the given partitions by timestamp. The returned offset for each partition is the earliest offset for which the timestamp is greater than or equal to the given timestamp. If the provided timestamp exceeds that of the last message in the partition, a value of Offset.End (-1) will be returned.

Declaration
public IReadOnlyList<TopicPartitionOffset> GetOffsetsForTimestamp(IEnumerable<TopicPartitionTimestamp> topicPartitionTimestamps, TimeSpan timeout)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<Confluent.Kafka.TopicPartitionTimestamp> topicPartitionTimestamps

The list of partitions with the target timestamps.
System.TimeSpan timeout

The maximum amount of time to block waiting for the requested offsets.
Returns
Type Description
System.Collections.Generic.IReadOnlyList<Confluent.Kafka.TopicPartitionOffset>

The list of offsets for each partition.
| Improve this doc View source

RollbackCoreAsync(IReadOnlyCollection<KafkaOffset>)

Declaration
protected override Task RollbackCoreAsync(IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyCollection<KafkaOffset> brokerMessageIdentifiers
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Silverback.Messaging.Broker.Consumer<Silverback.Messaging.Broker.KafkaBroker, Silverback.Messaging.KafkaConsumerEndpoint, Silverback.Messaging.Broker.KafkaOffset>.RollbackCoreAsync(System.Collections.Generic.IReadOnlyCollection<Silverback.Messaging.Broker.KafkaOffset>)
| Improve this doc View source

StartCoreAsync()

Declaration
protected override Task StartCoreAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
| Improve this doc View source

StopCoreAsync()

Declaration
protected override Task StopCoreAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
| Improve this doc View source

WaitUntilConsumingStoppedCoreAsync()

Declaration
protected override Task WaitUntilConsumingStoppedCoreAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

Implements

System.IDisposable