ClusterClientSettings

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 information
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 information
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

Number of potentially lost/delayed heartbeats that will be accepted before considering it to be an anomaly.
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.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bufferSize: Int

If connection to the receptionist is not established the client will buffer this number of messages and deliver them the connection is established.
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.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (ClusterClientSettings) ⇒ Boolean, msg: ⇒ Any): ClusterClientSettings

Implicit information
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 information
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 information
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 information
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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
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
def hashCode(): Int

Definition Classes
AnyRef → Any
val heartbeatInterval: FiniteDuration

How often failure detection heartbeat messages for detection of failed connections should be sent.
val initialContacts: Set[ActorPath]

Actor paths of the ClusterReceptionist actors on the servers (cluster nodes) that the client will try to contact initially.
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"
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val reconnectTimeout: Option[FiniteDuration]

If the connection to the receptionist is lost and cannot be re-established within this duration the cluster client will be stopped.
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
val refreshContactsInterval: FiniteDuration

Interval at which the client will ask the ClusterReceptionist for new contact points to be used for next reconnect.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): 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 information
This member is added by an implicit conversion from ClusterClientSettings to ArrowAssoc[ClusterClientSettings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterClientSettings to any2stringadd[ClusterClientSettings]

Inherited by implicit conversion StringFormat from ClusterClientSettings to StringFormat[ClusterClientSettings]

Inherited by implicit conversion Ensuring from ClusterClientSettings to Ensuring[ClusterClientSettings]

Inherited by implicit conversion ArrowAssoc from ClusterClientSettings to ArrowAssoc[ClusterClientSettings]

Ungrouped

Related Docs: object ClusterClientSettings | package client

final class ClusterClientSettings extends NoSerializationVerificationNeeded

Instance Constructors

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

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ClusterClientSettings, B)

final def ==(arg0: Any): Boolean

val acceptableHeartbeatPause: FiniteDuration

final def asInstanceOf[T0]: T0

val bufferSize: Int

def clone(): AnyRef

def ensuring(cond: (ClusterClientSettings) ⇒ Boolean, msg: ⇒ Any): ClusterClientSettings

def ensuring(cond: (ClusterClientSettings) ⇒ Boolean): ClusterClientSettings

def ensuring(cond: Boolean, msg: ⇒ Any): ClusterClientSettings

def ensuring(cond: Boolean): ClusterClientSettings

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val establishingGetContactsInterval: FiniteDuration

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

val heartbeatInterval: FiniteDuration

val initialContacts: Set[ActorPath]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val reconnectTimeout: Option[FiniteDuration]

val refreshContactsInterval: FiniteDuration

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withBufferSize(bufferSize: Int): ClusterClientSettings

def withEstablishingGetContactsInterval(establishingGetContactsInterval: FiniteDuration): ClusterClientSettings

def withHeartbeat(heartbeatInterval: FiniteDuration, acceptableHeartbeatPause: FiniteDuration): ClusterClientSettings

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

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

def withReconnectTimeout(reconnectTimeout: Option[FiniteDuration]): ClusterClientSettings

def withRefreshContactsInterval(refreshContactsInterval: FiniteDuration): ClusterClientSettings

def →[B](y: B): (ClusterClientSettings, B)

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterClientSettings to any2stringadd[ClusterClientSettings]

Inherited by implicit conversion StringFormat from ClusterClientSettings to StringFormat[ClusterClientSettings]

Inherited by implicit conversion Ensuring from ClusterClientSettings to Ensuring[ClusterClientSettings]

Inherited by implicit conversion ArrowAssoc from ClusterClientSettings to ArrowAssoc[ClusterClientSettings]

Ungrouped