Class ClusterClientSettings

TBD

Inheritance

Object

ClusterClientSettings

Implements

INoSerializationVerificationNeeded

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Cluster.Tools.Client

Assembly: Akka.Cluster.Tools.dll

Syntax

public sealed class ClusterClientSettings : INoSerializationVerificationNeeded

Constructors

ClusterClientSettings(IImmutableSet<ActorPath>, TimeSpan, TimeSpan, TimeSpan, TimeSpan, Int32, Boolean, Boolean, ClusterClientDiscoverySettings, Nullable<TimeSpan>, Boolean)

TBD

Declaration

public ClusterClientSettings(IImmutableSet<ActorPath> initialContacts, TimeSpan establishingGetContactsInterval, TimeSpan refreshContactsInterval, TimeSpan heartbeatInterval, TimeSpan acceptableHeartbeatPause, int bufferSize, bool useLegacySerialization, bool useInitialContactsDiscovery, ClusterClientDiscoverySettings discoverySettings = null, TimeSpan? reconnectTimeout = null, bool verboseLogging = false)

Parameters

Type	Name	Description
System.Collections.Immutable.IImmutableSet<ActorPath>	initialContacts	TBD
TimeSpan	establishingGetContactsInterval	TBD
TimeSpan	refreshContactsInterval	TBD
TimeSpan	heartbeatInterval	TBD
TimeSpan	acceptableHeartbeatPause	TBD
Int32	bufferSize	TBD
Boolean	useLegacySerialization	TBD
Boolean	useInitialContactsDiscovery	TBD
ClusterClientDiscoverySettings	discoverySettings	TBD
Nullable<TimeSpan>	reconnectTimeout	TBD
Boolean	verboseLogging	TBD

Exceptions

Type	Condition
ArgumentException	TBD

ClusterClientSettings(IImmutableSet<ActorPath>, TimeSpan, TimeSpan, TimeSpan, TimeSpan, Int32, Boolean, Nullable<TimeSpan>)

TBD

Declaration

[Obsolete("Use constructor with useInitialContactsDiscovery and discoverySettings argument instead. Since 1.5.25")]
public ClusterClientSettings(IImmutableSet<ActorPath> initialContacts, TimeSpan establishingGetContactsInterval, TimeSpan refreshContactsInterval, TimeSpan heartbeatInterval, TimeSpan acceptableHeartbeatPause, int bufferSize, bool useLegacySerialization, TimeSpan? reconnectTimeout = null)

Parameters

Type	Name	Description
System.Collections.Immutable.IImmutableSet<ActorPath>	initialContacts	TBD
TimeSpan	establishingGetContactsInterval	TBD
TimeSpan	refreshContactsInterval	TBD
TimeSpan	heartbeatInterval	TBD
TimeSpan	acceptableHeartbeatPause	TBD
Int32	bufferSize	TBD
Boolean	useLegacySerialization	TBD
Nullable<TimeSpan>	reconnectTimeout	TBD

Exceptions

Type	Condition
ArgumentException	TBD

ClusterClientSettings(IImmutableSet<ActorPath>, TimeSpan, TimeSpan, TimeSpan, TimeSpan, Int32, Nullable<TimeSpan>)

TBD

Declaration

[Obsolete("Use constructor with useLegacySerialization argument instead. Since 1.5.15")]
public ClusterClientSettings(IImmutableSet<ActorPath> initialContacts, TimeSpan establishingGetContactsInterval, TimeSpan refreshContactsInterval, TimeSpan heartbeatInterval, TimeSpan acceptableHeartbeatPause, int bufferSize, TimeSpan? reconnectTimeout = null)

Parameters

Type	Name	Description
System.Collections.Immutable.IImmutableSet<ActorPath>	initialContacts	TBD
TimeSpan	establishingGetContactsInterval	TBD
TimeSpan	refreshContactsInterval	TBD
TimeSpan	heartbeatInterval	TBD
TimeSpan	acceptableHeartbeatPause	TBD
Int32	bufferSize	TBD
Nullable<TimeSpan>	reconnectTimeout	TBD

Exceptions

Type	Condition
ArgumentException	TBD

Properties

AcceptableHeartbeatPause

Number of potentially lost/delayed heartbeats that will be accepted before considering it to be an anomaly. The ClusterClient is using the DeadlineFailureDetector, which will trigger if there are no heartbeats within the duration HeartbeatInterval + AcceptableHeartbeatPause.

Declaration

public TimeSpan AcceptableHeartbeatPause { get; }

Property Value

Type	Description
TimeSpan

BufferSize

If connection to the receptionist is not established the client will buffer this number of messages and deliver them the connection is established. When the buffer is full old messages will be dropped when new messages are sent via the client. Use 0 to disable buffering, i.e. messages will be dropped immediately if the location of the receptionist is unavailable.

Declaration

public int BufferSize { get; }

Property Value

Type	Description
Int32

DiscoverySettings

Declaration

public ClusterClientDiscoverySettings DiscoverySettings { get; }

Property Value

Type	Description
ClusterClientDiscoverySettings

EstablishingGetContactsInterval

Interval at which the client retries to establish contact with one of ClusterReceptionist on the servers (cluster nodes)

Declaration

public TimeSpan EstablishingGetContactsInterval { get; }

Property Value

Type	Description
TimeSpan

HeartbeatInterval

How often failure detection heartbeat messages for detection of failed connections should be sent.

Declaration

public TimeSpan HeartbeatInterval { get; }

Property Value

Type	Description
TimeSpan

InitialContacts

Actor paths of the ClusterReceptionist actors on the servers (cluster nodes) that the client will try to contact initially.

Declaration

public IImmutableSet<ActorPath> InitialContacts { get; }

Property Value

Type	Description
System.Collections.Immutable.IImmutableSet<ActorPath>

ReconnectTimeout

If the connection to the receptionist is lost and cannot be re-established within this duration the cluster client will be stopped. This makes it possible to watch it from another actor and possibly acquire a new list of InitialContacts from some external service registry

Declaration

public TimeSpan? ReconnectTimeout { get; }

Property Value

Type	Description
Nullable<TimeSpan>

RefreshContactsInterval

Interval at which the client will ask the ClusterReceptionist for new contact points to be used for next reconnect.

Declaration

public TimeSpan RefreshContactsInterval { get; }

Property Value

Type	Description
TimeSpan

UseInitialContactDiscovery

Declaration

public bool UseInitialContactDiscovery { get; }

Property Value

Type	Description
Boolean

UseLegacySerialization

If set to true, will cause all ClusterClient message to be serialized using the default Object serializer. If set to false, will cause all ClusterClient message to be serialized using ClusterClientMessageSerializer

Declaration

public bool UseLegacySerialization { get; }

Property Value

Type	Description
Boolean

VerboseLogging

Declaration

public bool VerboseLogging { get; }

Property Value

Type	Description
Boolean

Methods

Create(ActorSystem)

Create settings from the default configuration 'akka.cluster.client'.

Declaration

public static ClusterClientSettings Create(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	TBD

Returns

Type	Description
ClusterClientSettings	TBD

Exceptions

Type	Condition
ArgumentException	TBD

Create(Config)

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

Declaration

public static ClusterClientSettings Create(Config config)

Parameters

Type	Name	Description
Config	config	TBD

Returns

Type	Description
ClusterClientSettings	TBD

WithBufferSize(Int32)

TBD

Declaration

public ClusterClientSettings WithBufferSize(int bufferSize)

Parameters

Type	Name	Description
Int32	bufferSize	TBD

Returns

Type	Description
ClusterClientSettings	TBD

WithEstablishingGetContactsInterval(TimeSpan)

TBD

Declaration

public ClusterClientSettings WithEstablishingGetContactsInterval(TimeSpan value)

Parameters

Type	Name	Description
TimeSpan	value	TBD

Returns

Type	Description
ClusterClientSettings	TBD

WithHeartbeatInterval(TimeSpan)

TBD

Declaration

public ClusterClientSettings WithHeartbeatInterval(TimeSpan value)

Parameters

Type	Name	Description
TimeSpan	value	TBD

Returns

Type	Description
ClusterClientSettings	TBD

WithInitialContacts(IImmutableSet<ActorPath>)

TBD

Declaration

public ClusterClientSettings WithInitialContacts(IImmutableSet<ActorPath> initialContacts)

Parameters

Type	Name	Description
System.Collections.Immutable.IImmutableSet<ActorPath>	initialContacts	TBD

Returns

Type	Description
ClusterClientSettings	TBD

Exceptions

Type	Condition
ArgumentException	TBD

WithInitialContactsDiscovery(Boolean, ClusterClientDiscoverySettings)

Declaration

public ClusterClientSettings WithInitialContactsDiscovery(bool useInitialContactsDiscovery, ClusterClientDiscoverySettings discoverySettings = null)

Parameters

Type	Name	Description
Boolean	useInitialContactsDiscovery
ClusterClientDiscoverySettings	discoverySettings

Returns

Type	Description
ClusterClientSettings

WithReconnectTimeout(Nullable<TimeSpan>)

TBD

Declaration

public ClusterClientSettings WithReconnectTimeout(TimeSpan? reconnectTimeout)

Parameters

Type	Name	Description
Nullable<TimeSpan>	reconnectTimeout	TBD

Returns

Type	Description
ClusterClientSettings	TBD

WithRefreshContactsInterval(TimeSpan)

TBD

Declaration

public ClusterClientSettings WithRefreshContactsInterval(TimeSpan value)

Parameters

Type	Name	Description
TimeSpan	value	TBD

Returns

Type	Description
ClusterClientSettings	TBD

WithUseLegacySerialization(Boolean)

Declaration

public ClusterClientSettings WithUseLegacySerialization(bool useLegacySerialization)

Parameters

Type	Name	Description
Boolean	useLegacySerialization

Returns

Type	Description
ClusterClientSettings

Implements

INoSerializationVerificationNeeded

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)