26.7. Class PullQueueStorage
Namespace: ArmoniK.Core.Adapters.Amqp
Assembly: ArmoniK.Core.Adapters.Amqp.dll
public class PullQueueStorage : QueueStorage, IPullQueueStorage, IQueueStorage, IInitializable, IHealthCheckProvider
26.7.1. Inheritance
object ← QueueStorageBase ← QueueStorage ← PullQueueStorage
26.7.2. Implements
IPullQueueStorage, IQueueStorage, IInitializable, IHealthCheckProvider
26.7.3. Inherited Members
QueueStorage.ConnectionAmqp, QueueStorage.NbLinks, 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()
26.7.4. Constructors
26.7.4.1. PullQueueStorage(Amqp, IConnectionAmqp, ILogger<PullQueueStorage>)
public PullQueueStorage(Amqp options, IConnectionAmqp connectionAmqp, ILogger<PullQueueStorage> logger)
26.7.4.1.1. Parameters
options Amqp
connectionAmqp IConnectionAmqp
logger ILogger<PullQueueStorage>
26.7.5. Methods
26.7.5.1. Check(HealthCheckTag)
Checks the status of a class for the given health check type.
public override Task<HealthCheckResult> Check(HealthCheckTag tag)
26.7.5.1.1. Parameters
tag HealthCheckTag
Health check for which the class has to answer.
26.7.5.1.2. Returns
The result of the check containing the status of the class for the health check type.
26.7.5.2. Init(CancellationToken)
Executes an initialization process for the class
public override Task Init(CancellationToken cancellationToken)
26.7.5.2.1. Parameters
cancellationToken CancellationToken
Token used to cancel the execution of the method
26.7.5.2.2. Returns
Task representing the asynchronous execution of the method
26.7.5.3. PullMessagesAsync(string, int, CancellationToken)
Gets messages from the queue
public IAsyncEnumerable<IQueueMessageHandler> PullMessagesAsync(string partitionId, int nbMessages, CancellationToken cancellationToken = default)
26.7.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
26.7.5.3.2. Returns
IAsyncEnumerable<IQueueMessageHandler>
Enumerator allowing async iteration over the message queue