Class RabbitConsumer

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

Inheritance

object

Consumer

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>

RabbitConsumer

Implements

IConsumer

IDisposable

Inherited Members

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.Broker

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.Endpoint

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.CommitCoreAsync(IReadOnlyCollection<IBrokerMessageIdentifier>)

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.RollbackCoreAsync(IReadOnlyCollection<IBrokerMessageIdentifier>)

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.CommitCoreAsync(IReadOnlyCollection<RabbitDeliveryTag>)

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.RollbackCoreAsync(IReadOnlyCollection<RabbitDeliveryTag>)

Consumer.Id

Consumer.Broker

Consumer.Endpoint

Consumer.StatusInfo

Consumer.IsConnecting

Consumer.IsConnected

Consumer.IsConsuming

Consumer.IsDisconnecting

Consumer.ServiceProvider

Consumer.IsStopping

Consumer.ConnectAsync()

Consumer.DisconnectAsync()

Consumer.TriggerReconnectAsync()

Consumer.StartAsync()

Consumer.StopAsync()

Consumer.CommitAsync(IBrokerMessageIdentifier)

Consumer.CommitAsync(IReadOnlyCollection<IBrokerMessageIdentifier>)

Consumer.RollbackAsync(IBrokerMessageIdentifier)

Consumer.RollbackAsync(IReadOnlyCollection<IBrokerMessageIdentifier>)

Consumer.IncrementFailedAttempts(IRawInboundEnvelope)

Consumer.Dispose()

Consumer.CommitCoreAsync(IReadOnlyCollection<IBrokerMessageIdentifier>)

Consumer.RollbackCoreAsync(IReadOnlyCollection<IBrokerMessageIdentifier>)

Consumer.HandleMessageAsync(byte[], IReadOnlyCollection<MessageHeader>, string, IBrokerMessageIdentifier, ISequenceStore)

Consumer.SetReadyStatus()

Consumer.RevertReadyStatus()

Consumer.Dispose(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.Broker

Assembly: Silverback.Integration.RabbitMQ.dll

Syntax

public class RabbitConsumer : Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>, IConsumer, IDisposable

Constructors

RabbitConsumer(RabbitBroker, RabbitConsumerEndpoint, IBrokerBehaviorsProvider<IConsumerBehavior>, IServiceProvider, IInboundLogger<RabbitConsumer>)

Initializes a new instance of the RabbitConsumer class.

Declaration

public RabbitConsumer(RabbitBroker broker, RabbitConsumerEndpoint endpoint, IBrokerBehaviorsProvider<IConsumerBehavior> behaviorsProvider, IServiceProvider serviceProvider, IInboundLogger<RabbitConsumer> logger)

Parameters

Type	Name	Description
RabbitBroker	broker	The IBroker that is instantiating the consumer.
RabbitConsumerEndpoint	endpoint	The endpoint to be consumed.
IBrokerBehaviorsProvider<IConsumerBehavior>	behaviorsProvider	The IBrokerBehaviorsProvider<TBehavior>.
IServiceProvider	serviceProvider	The IServiceProvider to be used to resolve the needed services.
IInboundLogger<RabbitConsumer>	logger	The IInboundLogger<TCategoryName>.

Methods

CommitCoreAsync(IReadOnlyCollection<RabbitDeliveryTag>)

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

Declaration

protected override Task CommitCoreAsync(IReadOnlyCollection<RabbitDeliveryTag> brokerMessageIdentifiers)

Parameters

Type	Name	Description
IReadOnlyCollection<RabbitDeliveryTag>	brokerMessageIdentifiers	The identifiers of to message be committed.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.CommitCoreAsync(IReadOnlyCollection<RabbitDeliveryTag>)

ConnectCoreAsync()

Connects to the message broker.

Declaration

protected override Task ConnectCoreAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

Consumer.ConnectCoreAsync()

DisconnectCoreAsync()

Disconnects from the message broker.

Declaration

protected override Task DisconnectCoreAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

Consumer.DisconnectCoreAsync()

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

Consumer.GetCurrentSequenceStores()

Remarks

Used only for testing and maintained to preserve backward compatibility.

RollbackCoreAsync(IReadOnlyCollection<RabbitDeliveryTag>)

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<RabbitDeliveryTag> brokerMessageIdentifiers)

Parameters

Type	Name	Description
IReadOnlyCollection<RabbitDeliveryTag>	brokerMessageIdentifiers	The identifiers of to message be rolled back.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

Consumer<RabbitBroker, RabbitConsumerEndpoint, RabbitDeliveryTag>.RollbackCoreAsync(IReadOnlyCollection<RabbitDeliveryTag>)

StartCoreAsync()

Stops consuming while staying connected to the message broker.

Declaration

protected override Task StartCoreAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

Consumer.StartCoreAsync()

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

Consumer.StopCoreAsync()

WaitUntilConsumingStoppedCoreAsync()

Waits until the consuming is stopped.

Declaration

protected override Task WaitUntilConsumingStoppedCoreAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

Consumer.WaitUntilConsumingStoppedCoreAsync()

Implements

IConsumer

IDisposable