23.100. Interface IPullQueueStorage

Namespace: ArmoniK.Core.Base
Assembly: ArmoniK.Core.Base.dll

Interface to retrieve messages from the queue

public interface IPullQueueStorage : IQueueStorage, IInitializable, IHealthCheckProvider

23.100.1. Implements

IQueueStorage, IInitializable, IHealthCheckProvider

23.100.2. Methods

23.100.2.1. PullMessagesAsync(string, int, CancellationToken)

Gets messages from the queue

IAsyncEnumerable<IQueueMessageHandler> PullMessagesAsync(string partitionId, int nbMessages, CancellationToken cancellationToken = default)

23.100.2.1.1. Parameters

partitionId string

ArmoniK partition name

nbMessages int

Number of messages to retrieve

cancellationToken CancellationToken

Token used to cancel the execution of the method

23.100.2.1.2. Returns

IAsyncEnumerable<IQueueMessageHandler>

Enumerator allowing async iteration over the message queue