Class AzureStorageQueueService<T>

Namespace

FoundationaLLM.DataPipelineEngine.Services.Queueing

Assembly

FoundationaLLM.DataPipelineEngine.dll

Provides an implementation of the IMessageQueueService interface for Azure Storage Queues.

public class AzureStorageQueueService<T> : IMessageQueueService<T>

Type Parameters

T

Inheritance

object

AzureStorageQueueService<T>

Implements

IMessageQueueService<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

AzureStorageQueueService(string, string, ILogger<AzureStorageQueueService<T>>)

Constructs a new instance of the AzureStorageQueueService class.

public AzureStorageQueueService(string storageAccountName, string queueName, ILogger<AzureStorageQueueService<T>> logger)

Parameters

storageAccountName string

The name of the Azure Storage account.

queueName string

The name of the queue.

logger ILogger<AzureStorageQueueService<T>>

The logger used for logging.

Methods

DeleteMessage(DequeuedMessage<T>)

Deletes a message from the queue.

public Task<bool> DeleteMessage(DequeuedMessage<T> message)

Parameters

message DequeuedMessage<T>

The message to be deleted.

Returns

Task<bool>

true if the message was successfully deleted, false otherwise.

MessagesAvailable()

Inidicates whether there are messages available in the queue.

public Task<bool> MessagesAvailable()

Returns

Task<bool>

true if there are messages available, false otherwise.

ReceiveMessages(int)

Receives a specified number of messages from the queue.

public Task<IEnumerable<DequeuedMessage<T>>> ReceiveMessages(int messageCount)

Parameters

messageCount int

The number of messages to receive.

Returns

Task<IEnumerable<DequeuedMessage<T>>>

A list of dequeued messages.

UpdateMessageVisibilityTimeout(DequeuedMessage<T>, bool)

Updates the visibility timeout of a message in the queue.

public Task<DequeuedMessage<T>?> UpdateMessageVisibilityTimeout(DequeuedMessage<T> message, bool recoverFromError = false)

Parameters

message DequeuedMessage<T>

The message whose visibility timeout is updated.

recoverFromError bool

Indicates whether the reason for the update is the need to recover from an error or not.

Returns

Task<DequeuedMessage<T>>

A copy of the original dequeued message with the updated visibility timeout.