Class ClusterReceptionistSettings

TBD

Inheritance

object

ClusterReceptionistSettings

Implements

INoSerializationVerificationNeeded

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Cluster.Tools.Client

Assembly: Akka.Cluster.Tools.dll

Syntax

public sealed class ClusterReceptionistSettings : INoSerializationVerificationNeeded

Constructors

ClusterReceptionistSettings(string, int, TimeSpan, TimeSpan, TimeSpan, TimeSpan)

TBD

Declaration

public ClusterReceptionistSettings(string role, int numberOfContacts, TimeSpan responseTunnelReceiveTimeout, TimeSpan heartbeatInterval, TimeSpan acceptableHeartbeatPause, TimeSpan failureDetectionInterval)

Parameters

Type	Name	Description
string	role	TBD
int	numberOfContacts	TBD
TimeSpan	responseTunnelReceiveTimeout	TBD
TimeSpan	heartbeatInterval	TBD
TimeSpan	acceptableHeartbeatPause	TBD
TimeSpan	failureDetectionInterval	TBD

Properties

AcceptableHeartbeatPause

Number of potentially lost/delayed heartbeats that will be accepted before considering it to be an anomaly. The ClusterReceptionist is using the akka.remote.DeadlineFailureDetector, which will trigger if there are no heartbeats within the duration heartbeat-interval + acceptable-heartbeat-pause, i.e. 15 seconds with the default settings.

Declaration

public TimeSpan AcceptableHeartbeatPause { get; }

Property Value

Type	Description
TimeSpan

FailureDetectionInterval

Failure detection checking interval for checking all ClusterClients

Declaration

public TimeSpan FailureDetectionInterval { get; }

Property Value

Type	Description
TimeSpan

HeartbeatInterval

How often failure detection heartbeat messages should be received for each ClusterClient

Declaration

public TimeSpan HeartbeatInterval { get; }

Property Value

Type	Description
TimeSpan

NumberOfContacts

The receptionist will send this number of contact points to the client.

Declaration

public int NumberOfContacts { get; }

Property Value

Type	Description
int

ResponseTunnelReceiveTimeout

The actor that tunnel response messages to the client will be stopped after this time of inactivity.

Declaration

public TimeSpan ResponseTunnelReceiveTimeout { get; }

Property Value

Type	Description
TimeSpan

Role

Start the receptionist on members tagged with this role. All members are used if undefined.

Declaration

public string Role { get; }

Property Value

Type	Description
string

Methods

Create(ActorSystem)

Create settings from the default configuration "akka.cluster.client.receptionist".

Declaration

public static ClusterReceptionistSettings Create(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	TBD

Returns

Type	Description
ClusterReceptionistSettings	TBD

Exceptions

Type	Condition
ArgumentException	TBD

Create(Config)

Create settings from a configuration with the same layout as the default configuration "akka.cluster.client.receptionist".

Declaration

public static ClusterReceptionistSettings Create(Config config)

Parameters

Type	Name	Description
Config	config	TBD

Returns

Type	Description
ClusterReceptionistSettings	TBD

WithHeartbeat(TimeSpan, TimeSpan, TimeSpan)

TBD

Declaration

public ClusterReceptionistSettings WithHeartbeat(TimeSpan heartbeatInterval, TimeSpan acceptableHeartbeatPause, TimeSpan failureDetectionInterval)

Parameters

Type	Name	Description
TimeSpan	heartbeatInterval	TBD
TimeSpan	acceptableHeartbeatPause	TBD
TimeSpan	failureDetectionInterval	TBD

Returns

Type	Description
ClusterReceptionistSettings	TBD

WithNumberOfContacts(int)

TBD

Declaration

public ClusterReceptionistSettings WithNumberOfContacts(int numberOfContacts)

Parameters

Type	Name	Description
int	numberOfContacts	TBD

Returns

Type	Description
ClusterReceptionistSettings	TBD

WithResponseTunnelReceiveTimeout(TimeSpan)

TBD

Declaration

public ClusterReceptionistSettings WithResponseTunnelReceiveTimeout(TimeSpan responseTunnelReceiveTimeout)

Parameters

Type	Name	Description
TimeSpan	responseTunnelReceiveTimeout	TBD

Returns

Type	Description
ClusterReceptionistSettings	TBD

WithRole(string)

TBD

Declaration

public ClusterReceptionistSettings WithRole(string role)

Parameters

Type	Name	Description
string	role	TBD

Returns

Type	Description
ClusterReceptionistSettings	TBD

WithoutRole()

TBD

Declaration

public ClusterReceptionistSettings WithoutRole()

Returns

Type	Description
ClusterReceptionistSettings	TBD

Implements

INoSerializationVerificationNeeded

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)