Class TableBasedDistributedLockSettings

The DistributedLock settings.

Inheritance
object
DistributedLockSettings
TableBasedDistributedLockSettings
EntityFrameworkLockSettings
PostgreSqlTableLockSettings
Inherited Members
Namespace: Silverback.Lock
Assembly: Silverback.Storage.Relational.dll
Syntax
public abstract record TableBasedDistributedLockSettings : DistributedLockSettings, IValidatableSettings, IEquatable<DistributedLockSettings>, IEquatable<TableBasedDistributedLockSettings>

Constructors

TableBasedDistributedLockSettings(TableBasedDistributedLockSettings)

The DistributedLock settings.

Declaration
protected TableBasedDistributedLockSettings(TableBasedDistributedLockSettings original)
Parameters
Type Name Description
TableBasedDistributedLockSettings original

TableBasedDistributedLockSettings(string)

Initializes a new instance of the TableBasedDistributedLockSettings class.

Declaration
protected TableBasedDistributedLockSettings(string lockName)
Parameters
Type Name Description
string lockName

The name of the lock.

Properties

AcquireInterval

Gets the interval between two attempts to acquire the lock. The default is 1 second.

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

EqualityContract

The DistributedLock settings.

Declaration
protected override Type EqualityContract { get; }
Property Value
Type Description
Type
Overrides

HeartbeatInterval

Gets the interval between two heartbeat updates. The default is 500 milliseconds.

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

LockTimeout

Gets the maximum duration between two heartbeat updates, after which the lock is considered lost. The default is 5 seconds.

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

Methods

Equals(DistributedLockSettings?)

The DistributedLock settings.

Declaration
public override sealed bool Equals(DistributedLockSettings? other)
Parameters
Type Name Description
DistributedLockSettings other
Returns
Type Description
bool
Overrides

Equals(TableBasedDistributedLockSettings?)

The DistributedLock settings.

Declaration
public virtual bool Equals(TableBasedDistributedLockSettings? other)
Parameters
Type Name Description
TableBasedDistributedLockSettings other
Returns
Type Description
bool

Equals(object?)

The DistributedLock settings.

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

GetHashCode()

The DistributedLock settings.

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

PrintMembers(StringBuilder)

The DistributedLock settings.

Declaration
protected override bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
Overrides

ToString()

The DistributedLock settings.

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

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

Declaration
public override void Validate()
Overrides

Operators

operator ==(TableBasedDistributedLockSettings?, TableBasedDistributedLockSettings?)

The DistributedLock settings.

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

operator !=(TableBasedDistributedLockSettings?, TableBasedDistributedLockSettings?)

The DistributedLock settings.

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

Implements