23.72. Class QueueStorageBase

Namespace: ArmoniK.Core.Adapters.QueueCommon
Assembly: ArmoniK.Core.Adapters.QueueCommon.dll

Represents the base class for queue storage implementations

public class QueueStorageBase : IQueueStorage, IInitializable, IHealthCheckProvider

23.72.1. Inheritance

objectQueueStorageBase

23.72.2. Implements

IQueueStorage, IInitializable, IHealthCheckProvider

23.72.3. Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

23.72.4. Constructors

23.72.4.1. QueueStorageBase(Amqp)

Initializes a new instance of the class with the specified AMQP options.

protected QueueStorageBase(Amqp options)

23.72.4.1.1. Parameters

options Amqp

The AMQP options to configure the queue storage.

23.72.4.1.2. Exceptions

ArgumentOutOfRangeException

Thrown when any of the required options are not defined or invalid.

23.72.5. Fields

23.72.5.1. IsInitialized

Gets a value indicating whether the queue storage has been initialized.

public bool IsInitialized

23.72.5.1.1. Field Value

bool

23.72.5.2. Options

Represents the configuration settings for the AMQP (Advanced Message Queuing Protocol) connection.

public readonly Amqp Options

23.72.5.2.1. Field Value

Amqp

23.72.6. Properties

23.72.6.1. MaxPriority

Max priority supported by the queue

public int MaxPriority { get; }

23.72.6.1.1. Property Value

int

23.72.7. Methods

23.72.7.1. Check(HealthCheckTag)

Checks the status of a class for the given health check type.

public virtual Task<HealthCheckResult> Check(HealthCheckTag tag)

23.72.7.1.1. Parameters

tag HealthCheckTag

Health check for which the class has to answer.

23.72.7.1.2. Returns

Task<HealthCheckResult>

The result of the check containing the status of the class for the health check type.

23.72.7.2. Init(CancellationToken)

Executes an initialization process for the class

public virtual Task Init(CancellationToken cancellationToken)

23.72.7.2.1. Parameters

cancellationToken CancellationToken

Token used to cancel the execution of the method

23.72.7.2.2. Returns

Task

Task representing the asynchronous execution of the method