Class LeaseSettings

The settings used for the Lease

Inheritance
object
LeaseSettings
Inherited Members
Namespace: Akka.Coordination
Assembly: Akka.Coordination.dll
Syntax
public sealed class LeaseSettings

Constructors

| Edit this page View Source

LeaseSettings(string, string, TimeoutSettings, Config)

Creates a new instance of the LeaseSettings.

Declaration
public LeaseSettings(string leaseName, string ownerName, TimeoutSettings timeoutSettings, Config leaseConfig)
Parameters
Type Name Description
string leaseName

Lease name
string ownerName

Lease owner
TimeoutSettings timeoutSettings

Timeout settings
Config leaseConfig

Lease config

Properties

| Edit this page View Source

LeaseConfig

Lease config

Declaration
public Config LeaseConfig { get; }
Property Value
Type Description
Config
| Edit this page View Source

LeaseName

Lease name

Declaration
public string LeaseName { get; }
Property Value
Type Description
string
| Edit this page View Source

OwnerName

Lease owner

Declaration
public string OwnerName { get; }
Property Value
Type Description
string
| Edit this page View Source

TimeoutSettings

Timeout settings

Declaration
public TimeoutSettings TimeoutSettings { get; }
Property Value
Type Description
TimeoutSettings

Methods

| Edit this page View Source

Create(Config, string, string)

Creates a new LeaseSettings instance.

Declaration
public static LeaseSettings Create(Config config, string leaseName, string ownerName)
Parameters
Type Name Description
Config config

Lease config
string leaseName

Lease name
string ownerName

Lease owner
Returns
Type Description
LeaseSettings

The requested settings.
| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
| Edit this page View Source

WithTimeoutSettings(TimeoutSettings)

Create a LeaseSettings with specified TimeoutSettings.

Declaration
public LeaseSettings WithTimeoutSettings(TimeoutSettings timeoutSettings)
Parameters
Type Name Description
TimeoutSettings timeoutSettings

timeout settings
Returns
Type Description
LeaseSettings

Extension Methods