 | ClusterClientSettings Class |
TBD
Inheritance HierarchyNamespace: Akka.Cluster.Tools.Client
Assembly: Akka.Cluster.Tools (in Akka.Cluster.Tools.dll) Version: 1.2.3.42 (1.2.3.42)
SyntaxThe ClusterClientSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ClusterClientSettings |
TBD
|
Properties| Name | Description | |
|---|---|---|
 | 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.
|
| 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.
|
| EstablishingGetContactsInterval |
Interval at which the client retries to establish contact with one of ClusterReceptionist on the servers (cluster nodes)
|
| HeartbeatInterval |
How often failure detection heartbeat messages for detection of failed connections should be sent.
|
| InitialContacts |
Actor paths of the ClusterReceptionist actors on the servers (cluster nodes) that the client will try to contact initially.
|
| 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
|
| RefreshContactsInterval |
Interval at which the client will ask the ClusterReceptionist for new contact points to be used for next reconnect.
|
Methods| Name | Description | |
|---|---|---|
 | Create(ActorSystem) |
Create settings from the default configuration 'akka.cluster.client'.
|
| Create(Config) |
Create settings from a configuration with the same layout as the default configuration 'akka.cluster.client'.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WithBufferSize |
TBD
|
| WithEstablishingGetContactsInterval |
TBD
|
| WithHeartbeatInterval |
TBD
|
| WithInitialContacts |
TBD
|
| WithReconnectTimeout |
TBD
|
| WithRefreshContactsInterval |
TBD
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsInstanceOfT |
TBD
(Defined by Extensions.) |
| Match | Overloaded.
Matches the specified target.
(Defined by PatternMatch.) |
| MatchT | Overloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.) |
See Also