final class ClusterClientSettings extends NoSerializationVerificationNeeded

Annotations
@deprecated
Deprecated

(Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/libraries/akka-core/2.6/cluster-client.html#migration-to-akka-grpc

Source
ClusterClient.scala
Linear Supertypes
NoSerializationVerificationNeeded, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterClientSettings
  2. NoSerializationVerificationNeeded
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClusterClientSettings(initialContacts: Set[ActorPath], establishingGetContactsInterval: FiniteDuration, refreshContactsInterval: FiniteDuration, heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration, bufferSize: Int)

    For binary/source compatibility

  2. new ClusterClientSettings(initialContacts: Set[ActorPath], establishingGetContactsInterval: FiniteDuration, refreshContactsInterval: FiniteDuration, heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration, bufferSize: Int, reconnectTimeout: Option[FiniteDuration])

    initialContacts

    Actor paths of the ClusterReceptionist actors on the servers (cluster nodes) that the client will try to contact initially. It is mandatory to specify at least one initial contact. The path of the default receptionist is "akka://system@hostname:port/system/receptionist"

    establishingGetContactsInterval

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

    refreshContactsInterval

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

    heartbeatInterval

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

    acceptableHeartbeatPause

    Number of potentially lost/delayed heartbeats that will be accepted before considering it to be an anomaly. The ClusterClient is using the akka.remote.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.

    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

Value Members

  1. val acceptableHeartbeatPause: FiniteDuration
  2. val bufferSize: Int
  3. val establishingGetContactsInterval: FiniteDuration
  4. val heartbeatInterval: FiniteDuration
  5. val initialContacts: Set[ActorPath]
  6. val reconnectTimeout: Option[FiniteDuration]
  7. val refreshContactsInterval: FiniteDuration
  8. def withBufferSize(bufferSize: Int): ClusterClientSettings
  9. def withEstablishingGetContactsInterval(establishingGetContactsInterval: FiniteDuration): ClusterClientSettings
  10. def withHeartbeat(heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration): ClusterClientSettings
  11. def withInitialContacts(initialContacts: Set[ActorPath]): ClusterClientSettings

    Java API

  12. def withInitialContacts(initialContacts: Set[ActorPath]): ClusterClientSettings

    Scala API

  13. def withReconnectTimeout(reconnectTimeout: Option[FiniteDuration]): ClusterClientSettings
  14. def withRefreshContactsInterval(refreshContactsInterval: FiniteDuration): ClusterClientSettings