AzureStorageQueueOptions

Specifies the options required to leverage Azure Queue Storage as the SimpleMessageBus backing queue.

Definition

Assembly: CloudNimble.SimpleMessageBus.Core.dll

Namespace: CloudNimble.SimpleMessageBus.Core

Inheritance: System.Object

Syntax

CloudNimble.SimpleMessageBus.Core.AzureStorageQueueOptions

Summary

Specifies the options required to leverage Azure Queue Storage as the SimpleMessageBus backing queue.

Constructors

.ctor

The default constructor, which sets the default values equal to the values specified in AzureStorageQueueConstants.

Syntax

public AzureStorageQueueOptions()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

CompletedQueueName

A String representing the name of the Queue that successfully-executed messages will be stored in.

Syntax

public string CompletedQueueName { get; set; }

Property Value

Type: string

Remarks

Messages will stay in that Queue for the lifetime specified by the Queue, and is useful for diagnosing or re-running requests.

ConcurrentJobs

An Int32 representing the number of Messages that can be processed simultaneously. The default is 16.

Syntax

public int ConcurrentJobs { get; set; }

Property Value

Type: int

MessageEncoding

Sets the MessageEncoding for Queue messages. Defaults to AzureStorageQueueEncoding.None.

Syntax

public CloudNimble.SimpleMessageBus.Core.AzureStorageQueueEncoding MessageEncoding { get; set; }

Property Value

Type: CloudNimble.SimpleMessageBus.Core.AzureStorageQueueEncoding

Remarks

SimpleMessageBus defaulted to None in previous versions. This setting helps align the Azure Queues SDK QueueClient, which by default sets MessageEncoding = QueueMessageEncoding.None, and WebJobs SDK QueueTrigger, which by default sets MessageEncoding = QueueMessageEncoding.Base64. (I know, isn’t that awesome?!?).

QueueName

A String representing the name of the Queue in Azure Queue Storage.

Syntax

public string QueueName { get; set; }

Property Value

Type: string

Remarks

See https://coderwall.com/p/g2xeua for more information about queue name requirements.

StorageConnectionString

A String representing the ConnectionString for your Azure Storage account.

Syntax

public string StorageConnectionString { get; set; }

Property Value

Type: string

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?