Class TimeoutSettings

The timeout settings used for the Lease

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

Constructors

| Edit this page View Source

TimeoutSettings(TimeSpan, TimeSpan, TimeSpan)

Creates a new TimeoutSettings instance.

Declaration
public TimeoutSettings(TimeSpan heartbeatInterval, TimeSpan heartbeatTimeout, TimeSpan operationTimeout)
Parameters
Type Name Description
TimeSpan heartbeatInterval

Interval for communicating with the third party to confirm the lease is still held
TimeSpan heartbeatTimeout

If the node that acquired the leases crashes, how long should the lease be held before another owner can get it
TimeSpan operationTimeout

Lease implementations are expected to time out acquire and release calls or document that they do not implement an operation timeout

Properties

| Edit this page View Source

HeartbeatInterval

Interval for communicating with the third party to confirm the lease is still held

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

HeartbeatTimeout

If the node that acquired the leases crashes, how long should the lease be held before another owner can get it

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

OperationTimeout

Lease implementations are expected to time out acquire and release calls or document that they do not implement an operation timeout

Declaration
public TimeSpan OperationTimeout { get; }
Property Value
Type Description
TimeSpan

Methods

| Edit this page View Source

Create(Config)

Creates a new TimeoutSettings instance.

Declaration
public static TimeoutSettings Create(Config config)
Parameters
Type Name Description
Config config

Lease config
Returns
Type Description
TimeoutSettings

The requested settings.
| Edit this page View Source

ToString()

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

WithHeartbeatInterval(TimeSpan)

Create a TimeoutSettings with specified heartbeat interval.

Declaration
public TimeoutSettings WithHeartbeatInterval(TimeSpan heartbeatInterval)
Parameters
Type Name Description
TimeSpan heartbeatInterval

Interval for communicating with the third party to confirm the lease is still held
Returns
Type Description
TimeoutSettings
| Edit this page View Source

WithHeartbeatTimeout(TimeSpan)

Create a TimeoutSettings with specified heartbeat timeout.

Declaration
public TimeoutSettings WithHeartbeatTimeout(TimeSpan heartbeatTimeout)
Parameters
Type Name Description
TimeSpan heartbeatTimeout

If the node that acquired the leases crashes, how long should the lease be held before another owner can get it
Returns
Type Description
TimeoutSettings
| Edit this page View Source

withOperationTimeout(TimeSpan)

Create a TimeoutSettings with specified operation timeout.

Declaration
public TimeoutSettings withOperationTimeout(TimeSpan operationTimeout)
Parameters
Type Name Description
TimeSpan operationTimeout

Lease implementations are expected to time out acquire and release calls or document that they do not implement an operation timeout
Returns
Type Description
TimeoutSettings

Extension Methods