Skip to content

RabbitMQ

PM> Install-Package Shuttle.Esb.RabbitMQ

This RabbitMQ implementation follows the at-least-once delivery mechanism supported by Shuttle.Esb.

If necessary you may want to use an outbox for a store-and-forward solution. By using a transactional outbox such as the Shuttle.Esb.Sql.Queue implementation you could roll back sending of messages on failure.

Installation

If you need to install RabbitMQ you can follow these instructions.

Configuration

The URI structure is rabbitmq://configuration-name/queue-name.

c#
services.AddRabbitMQ(builder =>
{
    builder.AddOptions("local", new RabbitMQOptions
    {
        Host = "localhost",
        VirtualHost = "/",
        Port = -1,
        Username = "shuttle",
        Password = "shuttle!",
        PrefetchCount = 25,
        QueueTimeout = TimeSpan.FromMilliseconds(25),
        RequestedHeartbeat = TimeSpan.FromSeconds(30),
        ConnectionCloseTimeout = TimeSpan.FromSeconds(1),
        OperationRetryCount = 3,
        UseBackgroundThreadsForIO = true,
        Priority = 0,
        Persistent = true,
        Durable = true
    });
});

The default JSON settings structure is as follows:

json
{
  "Shuttle": {
    "RabbitMQ": {
      "local": {
        "Host": "localhost",
        "VirtualHost": "/",
        "Port": -1,
        "Username": "shuttle",
        "Password": "shuttle!",
        "PrefetchCount": 25,
        "QueueTimeout": "00:00:25",
        "RequestedHeartbeat": "00:00:30",
        "ConnectionCloseTimeout": "00:00:01",
        "OperationRetryCount": 3,
        "UseBackgroundThreadsForIO": true,
        "Priority": 0,
        "Persistent": true,
        "Durable": true
      }
    }
  }
}

Options

OptionDefaultDescription
HostThe RabbitMQ host to connect to.
VirtualHost"/"The virtual host to connect to.
Port-1Specifies the port to connect to. A value of -1 represents AmqpTcpEndpoint.UseDefaultPort.
UsernameThe username to send as a credential.
PasswordThe password to send as a credential.
PrefetchCount25Specifies the number of messages to prefetch from the queue.
QueueTimeout00:00:25How long to wait when retrieving a message from the queue before timing out and returing null.
RequestedHeartbeat00:00:30Heartbeat timeout to use when negotiating with the server.
ConnectionCloseTimeout00:00:01The duration to wait wait for connections to be closed.
OperationRetryCount3How many times to retry relevant queue operations in the event that they fail. Once the retries have run out the original exception is thrown.
UseBackgroundThreadsForIOtrueDetermines whether backgrounds threads are used for the I/O loop.
Priority0Determines the number of priorities (x-max-priority) supported by the queue.
PersistenttrueDetermines whether messages will be persisted. Please be sure of the possible consequences before setting to 'false'.
DurabletrueDetermines whether the queue is durable. Please be sure of the possible consequences before setting to 'false'.