final class ClusterClientSettings extends NoSerializationVerificationNeeded
- Alphabetic
- By Inheritance
- ClusterClientSettings
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ClusterClientSettings(initialContacts: Set[ActorPath], establishingGetContactsInterval: FiniteDuration, refreshContactsInterval: FiniteDuration, heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration, bufferSize: Int)
For binary/source compatibility
-
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.tcp://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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to any2stringadd[ClusterClientSettings] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (ClusterClientSettings, B)
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to ArrowAssoc[ClusterClientSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val acceptableHeartbeatPause: FiniteDuration
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val bufferSize: Int
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (ClusterClientSettings) ⇒ Boolean, msg: ⇒ Any): ClusterClientSettings
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to Ensuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (ClusterClientSettings) ⇒ Boolean): ClusterClientSettings
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to Ensuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ClusterClientSettings
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to Ensuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): ClusterClientSettings
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to Ensuring[ClusterClientSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val establishingGetContactsInterval: FiniteDuration
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to StringFormat[ClusterClientSettings] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val heartbeatInterval: FiniteDuration
- val initialContacts: Set[ActorPath]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val reconnectTimeout: Option[FiniteDuration]
- val refreshContactsInterval: FiniteDuration
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def withBufferSize(bufferSize: Int): ClusterClientSettings
- def withEstablishingGetContactsInterval(establishingGetContactsInterval: FiniteDuration): ClusterClientSettings
- def withHeartbeat(heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration): ClusterClientSettings
-
def
withInitialContacts(initialContacts: Set[ActorPath]): ClusterClientSettings
Java API
-
def
withInitialContacts(initialContacts: Set[ActorPath]): ClusterClientSettings
Scala API
- def withReconnectTimeout(reconnectTimeout: Option[FiniteDuration]): ClusterClientSettings
- def withRefreshContactsInterval(refreshContactsInterval: FiniteDuration): ClusterClientSettings
-
def
→[B](y: B): (ClusterClientSettings, B)
- Implicit
- This member is added by an implicit conversion from ClusterClientSettings to ArrowAssoc[ClusterClientSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc