Interface IConsumerBuilder

Namespace

RabbitMQ.AMQP.Client

Assembly

RabbitMQ.AMQP.Client.dll

public interface IConsumerBuilder

Methods

BuildAndStartAsync(CancellationToken)

Task<IConsumer> BuildAndStartAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IConsumer>

InitialCredits(int)

IConsumerBuilder InitialCredits(int initialCredits)

Parameters

initialCredits int

Returns

IConsumerBuilder

MessageHandler(MessageHandler)

Sets the delegate that processes each received message. The handler runs on the consumer's processing loop; its code must be safe: handle exceptions, settle each message via IContext (Accept/Discard/Requeue).

IConsumerBuilder MessageHandler(MessageHandler handler)

Parameters

handler MessageHandler

The message handler delegate.

Returns

IConsumerBuilder

The builder for fluent configuration.

Queue(IQueueSpecification)

IConsumerBuilder Queue(IQueueSpecification queueSpecification)

Parameters

queueSpecification IQueueSpecification

Returns

IConsumerBuilder

Queue(string?)

IConsumerBuilder Queue(string? queueName)

Parameters

queueName string

Returns

IConsumerBuilder

SettleStrategy(ConsumerSettleStrategy)

SettleStrategy: ConsumerSettleStrategy for more details on the Consumer Settle that can be enabled for the consumer.

IConsumerBuilder SettleStrategy(ConsumerSettleStrategy settleStrategy)

Parameters

settleStrategy ConsumerSettleStrategy

Returns

IConsumerBuilder

Stream()

IConsumerBuilder.IStreamOptions Stream()

Returns

IConsumerBuilder.IStreamOptions

SubscriptionListener(Action<ListenerContext>)

SubscriptionListener interface callback to add behavior before a subscription is created. This callback is meant for stream consumers: it can be used to dynamically set the offset the consumer attaches to in the stream. It is called when the consumer is first created and when the client has to re-subscribe (e.g. after a disconnection).

IConsumerBuilder SubscriptionListener(Action<IConsumerBuilder.ListenerContext> listenerContext)

Parameters

listenerContext Action<IConsumerBuilder.ListenerContext>

Contains the listenerContext, see IConsumerBuilder.ListenerContext

Returns

IConsumerBuilder

IConsumerBuilderThe consumer builder.