ClusterClientSettings

org.apache.pekko.cluster.client.ClusterClientSettings
See theClusterClientSettings companion object
final class ClusterClientSettings(val initialContacts: Set[ActorPath], val establishingGetContactsInterval: FiniteDuration, val refreshContactsInterval: FiniteDuration, val heartbeatInterval: FiniteDuration, val acceptableHeartbeatPause: FiniteDuration, val bufferSize: Int, val reconnectTimeout: Option[FiniteDuration]) extends NoSerializationVerificationNeeded

Value parameters

acceptableHeartbeatPause

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

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. It is mandatory to specify at least one initial contact. The path of the default receptionist is "pekko://system@hostname:port/system/receptionist"

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.

Attributes

Companion
object
Deprecated
[Since version Akka 2.6.0]
Source
ClusterClient.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Constructors

def this(initialContacts: Set[ActorPath], establishingGetContactsInterval: FiniteDuration, refreshContactsInterval: FiniteDuration, heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration, bufferSize: Int)

For binary/source compatibility

For binary/source compatibility

Attributes

Source
ClusterClient.scala

Concrete methods

Attributes

Source
ClusterClient.scala

Attributes

Source
ClusterClient.scala
def withHeartbeat(heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration): ClusterClientSettings

Attributes

Source
ClusterClient.scala

Scala API

Scala API

Attributes

Source
ClusterClient.scala

Java API

Java API

Attributes

Source
ClusterClient.scala

Attributes

Source
ClusterClient.scala