Class AzureQueueReceiveOptions

Namespace

Savvyio.Extensions.QueueStorage

Assembly

Savvyio.Extensions.QueueStorage.dll

Configuration options that is related to receiving messages from an Azure Storage Queue.

public class AzureQueueReceiveOptions : IParameterObject

Inheritance

object

AzureQueueReceiveOptions

Implements

IParameterObject

Examples

AzureQueueReceiveOptions configures the receive behavior of an Azure Queue Storage consumer, including visibility timeout and message count limits. Access it through AzureQueueOptions.ReceiveContext.

using System;
using Savvyio.Extensions.QueueStorage;

namespace ExampleApp;

public class AzureQueueReceiveSetup
{
    public static AzureQueueOptions CreateOptions()
    {
        var options = new AzureQueueOptions
        {
            ConnectionString = "UseDevelopmentStorage=true",
            QueueName = "account-commands"
        };
        AzureQueueReceiveOptions receiveOptions = options.ReceiveContext;
        receiveOptions.VisibilityTimeout = TimeSpan.FromMinutes(5);
        return options;
    }
}

Properties

NumberOfMessagesToTakePerRequest

Gets or sets the number of messages to return per request. Default is 10.

public int NumberOfMessagesToTakePerRequest { get; set; }

Property Value

int

The number of messages to return per request.

Remarks

Max. allowed value is limited to MaxNumberOfMessages.

VisibilityTimeout

Gets or sets the visibility timeout for the messages. Default is 30 seconds.

public TimeSpan VisibilityTimeout { get; set; }

Property Value

TimeSpan

The visibility timeout for the messages.

Remarks

The minimum allowed value is 1 second, and the maximum allowed value is limited to MaxVisibilityTimeout.
Reference: https://learn.microsoft.com/en-us/rest/api/storageservices/get-messages#uri-parameters