Class QueueOptions

Behavior options for the IPersistentQueue<T> implementation.

Inheritance
object
QueueOptions
Implements
Inherited Members
Namespace: Couchbase.DataStructures
Assembly: Couchbase.NetClient.dll
Syntax
public sealed record QueueOptions : IEquatable<QueueOptions>

Constructors

View Source

QueueOptions(int, TimeSpan?)

Behavior options for the IPersistentQueue<T> implementation.

Declaration
public QueueOptions(int CasMismatchRetries = 10, TimeSpan? Timeout = null)
Parameters
Type Name Description
int CasMismatchRetries

For operations that use Cas, such as Dequeue() the number of times a CasMismatchException will be retried internally.
TimeSpan? Timeout

The timeout value for operations that involve retries. Defaults to KvTimeout.

Fields

View Source

DefaultCasMismatchRetries

Declaration
public const int DefaultCasMismatchRetries = 10
Field Value
Type Description
int

Properties

View Source

CasMismatchRetries

For operations that use Cas, such as Dequeue() the number of times a CasMismatchException will be retried internally.

Declaration
public int CasMismatchRetries { get; init; }
Property Value
Type Description
int
View Source

Timeout

The timeout value for operations that involve retries. Defaults to KvTimeout.

Declaration
public TimeSpan? Timeout { get; init; }
Property Value
Type Description
TimeSpan?

Methods

View Source

Deconstruct(out int, out TimeSpan?)

Declaration
public void Deconstruct(out int CasMismatchRetries, out TimeSpan? Timeout)
Parameters
Type Name Description
int CasMismatchRetries
TimeSpan? Timeout
View Source

Equals(QueueOptions?)

Declaration
public bool Equals(QueueOptions? other)
Parameters
Type Name Description
QueueOptions other
Returns
Type Description
bool
View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(QueueOptions?, QueueOptions?)

Declaration
public static bool operator ==(QueueOptions? left, QueueOptions? right)
Parameters
Type Name Description
QueueOptions left
QueueOptions right
Returns
Type Description
bool
View Source

operator !=(QueueOptions?, QueueOptions?)

Declaration
public static bool operator !=(QueueOptions? left, QueueOptions? right)
Parameters
Type Name Description
QueueOptions left
QueueOptions right
Returns
Type Description
bool

Implements