final class ClusterClientSettings extends NoSerializationVerificationNeeded

Annotations
@deprecated
Deprecated

(Since version Akka 2.6.0) Use Apache Pekko gRPC instead, see https://pekko.apache.org/docs/pekko/current/cluster-client.html#migration-to-pekko-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 "pekko://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 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.

    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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toany2stringadd[ClusterClientSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterClientSettings, B)
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toArrowAssoc[ClusterClientSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val acceptableHeartbeatPause: FiniteDuration
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val bufferSize: Int
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def ensuring(cond: (ClusterClientSettings) => Boolean, msg: => Any): ClusterClientSettings
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toEnsuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ClusterClientSettings) => Boolean): ClusterClientSettings
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toEnsuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): ClusterClientSettings
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toEnsuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ClusterClientSettings
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toEnsuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. val establishingGetContactsInterval: FiniteDuration
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. val heartbeatInterval: FiniteDuration
  20. val initialContacts: Set[ActorPath]
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. val reconnectTimeout: Option[FiniteDuration]
  26. val refreshContactsInterval: FiniteDuration
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. def withBufferSize(bufferSize: Int): ClusterClientSettings
  33. def withEstablishingGetContactsInterval(establishingGetContactsInterval: FiniteDuration): ClusterClientSettings
  34. def withHeartbeat(heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration): ClusterClientSettings
  35. def withInitialContacts(initialContacts: Set[ActorPath]): ClusterClientSettings

    Java API

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

    Scala API

  37. def withReconnectTimeout(reconnectTimeout: Option[FiniteDuration]): ClusterClientSettings
  38. def withRefreshContactsInterval(refreshContactsInterval: FiniteDuration): ClusterClientSettings

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toStringFormat[ClusterClientSettings] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (ClusterClientSettings, B)
    Implicit
    This member is added by an implicit conversion from ClusterClientSettings toArrowAssoc[ClusterClientSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterClientSettings to any2stringadd[ClusterClientSettings]

Inherited by implicit conversion StringFormat fromClusterClientSettings to StringFormat[ClusterClientSettings]

Inherited by implicit conversion Ensuring fromClusterClientSettings to Ensuring[ClusterClientSettings]

Inherited by implicit conversion ArrowAssoc fromClusterClientSettings to ArrowAssoc[ClusterClientSettings]

Ungrouped