Show / Hide Table of Contents

# Class LockConfiguration

IIgniteLock configuration.

##### Inheritance

System.Object
LockConfiguration

##### Inherited Members

System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()

###### Namespace: Apache.Ignite.Core.Configuration

###### Assembly: Apache.Ignite.Core.dll

##### Syntax

    public class LockConfiguration

### Constructors

#### LockConfiguration()

Initializes a new instance of LockConfiguration class.

##### Declaration

    public LockConfiguration()

#### LockConfiguration(LockConfiguration)

Initializes a new instance of LockConfiguration class.

##### Declaration

    public LockConfiguration(LockConfiguration other)

##### Parameters

Type | Name | Description
--- | --- | ---
LockConfiguration | other | Other configuration to copy.

### Properties

#### IsFailoverSafe

Gets or sets a value indicating whether the lock should be failover-safe: when true, if any node leaves topology, all locks already acquired by that node are silently released and become available for other nodes to acquire. When false, all threads on other nodes waiting to acquire the lock are interrupted.

##### Declaration

    public bool IsFailoverSafe { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

#### IsFair

Gets or sets a value indicating whether the lock should be in fair mode.

When true, under contention, locks favor granting access to the longest-waiting thread. Otherwise this lock does not guarantee any particular access order.

Fair locks accessed by many threads may display lower overall throughput than those using the default setting, but have smaller variances in times to obtain locks and guarantee lack of starvation.

##### Declaration

    public bool IsFair { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

#### Name

Gets or sets the cluster-wide lock name.

##### Declaration

    public string Name { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |