Class RabbitMqCommandQueueOptions

Namespace

Savvyio.Extensions.RabbitMQ.Commands

Assembly

Savvyio.Extensions.RabbitMQ.dll

Configuration options for RabbitMqCommandQueue.

public class RabbitMqCommandQueueOptions : RabbitMqMessageOptions, IValidatableParameterObject, IParameterObject

Inheritance

object

RabbitMqMessageOptions

RabbitMqCommandQueueOptions

Implements

IValidatableParameterObject

IParameterObject

Derived

RabbitMqCommandQueueOptions<TMarker>

Inherited Members

RabbitMqMessageOptions.AmqpUrl

RabbitMqMessageOptions.Persistent

Constructors

RabbitMqCommandQueueOptions()

Initializes a new instance of the RabbitMqCommandQueueOptions class with default values.

public RabbitMqCommandQueueOptions()

Remarks

The following table shows the initial property values for an instance of RabbitMqCommandQueueOptions.

Property	Initial Value
QueueName	null
AutoAcknowledge	false
Durable	false
Exclusive	false
AutoDelete	false

Properties

AutoAcknowledge

Gets or sets a value indicating whether messages should be automatically acknowledged.

public bool AutoAcknowledge { get; set; }

Property Value

bool

true if messages are automatically acknowledged; otherwise, false.

AutoDelete

Gets or sets a value indicating whether the queue should be automatically deleted when no longer in use.

public bool AutoDelete { get; set; }

Property Value

bool

true if the queue is automatically deleted when the last consumer unsubscribes; otherwise, false.

Remarks

Auto-delete queues are deleted when the last consumer unsubscribes. If there are no consumers, the queue is not deleted.

Durable

Gets or sets a value indicating whether the queue should be durable.

public bool Durable { get; set; }

Property Value

bool

true if the queue should survive broker restarts; otherwise, false.

Remarks

Durable queues remain declared after a RabbitMQ broker restart, but messages in non-persistent queues will be lost.

Exclusive

Gets or sets a value indicating whether the queue should be exclusive.

public bool Exclusive { get; set; }

Property Value

bool

true if the queue is used by only one connection and deleted when that connection closes; otherwise, false.

Remarks

Exclusive queues are only accessible by the connection that declares them and are deleted when that connection closes.

QueueName

Gets or sets the name of the queue.

public string QueueName { get; set; }

Property Value

string

The name of the RabbitMQ queue to be used for command messages.

Methods

ValidateOptions()

Determines whether the public read-write properties of this instance are in a valid state.

public override void ValidateOptions()

Remarks

This method is expected to throw exceptions when one or more conditions fails to be in a valid state.

Exceptions

InvalidOperationException

QueueName cannot be null or empty.

See Also

RabbitMqMessageOptions