21.75. Class PullQueueStorage
Namespace: ArmoniK.Core.Adapters.RabbitMQ
Assembly: ArmoniK.Core.Adapters.RabbitMQ.dll
public class PullQueueStorage : QueueStorage, IPullQueueStorage, IQueueStorage, IInitializable, IHealthCheckProvider
21.75.1. Inheritance
21.75.2. Implements
IPullQueueStorage, IQueueStorage, IInitializable, IHealthCheckProvider
21.75.3. Inherited Members
QueueStorage.ConnectionRabbit, QueueStorage.Init(CancellationToken), QueueStorageBase.Options, QueueStorageBase.IsInitialized, QueueStorageBase.Init(CancellationToken), QueueStorageBase.Check(HealthCheckTag), QueueStorageBase.MaxPriority, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
21.75.4. Constructors
21.75.4.1. PullQueueStorage(Amqp, IConnectionRabbit, ILogger<PullQueueStorage>)
public PullQueueStorage(Amqp options, IConnectionRabbit connectionRabbit, ILogger<PullQueueStorage> logger)
21.75.4.1.1. Parameters
options Amqp
connectionRabbit IConnectionRabbit
logger ILogger<PullQueueStorage>
21.75.5. Methods
21.75.5.1. Check(HealthCheckTag)
Checks the status of a class for the given health check type.
public override Task<HealthCheckResult> Check(HealthCheckTag tag)
21.75.5.1.1. Parameters
tag HealthCheckTag
Health check for which the class has to answer.
21.75.5.1.2. Returns
The result of the check containing the status of the class for the health check type.
21.75.5.2. Init(CancellationToken)
Executes an initialization process for the class
public override Task Init(CancellationToken cancellationToken)
21.75.5.2.1. Parameters
cancellationToken CancellationToken
Token used to cancel the execution of the method
21.75.5.2.2. Returns
Task representing the asynchronous execution of the method
21.75.5.3. PullMessagesAsync(string, int, CancellationToken)
Gets messages from the queue
public IAsyncEnumerable<IQueueMessageHandler> PullMessagesAsync(string partitionId, int nbMessages, CancellationToken cancellationToken = default)
21.75.5.3.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
21.75.5.3.2. Returns
IAsyncEnumerable<IQueueMessageHandler>
Enumerator allowing async iteration over the message queue