Package org.apache.pekko.cluster.singleton

Class ClusterSingletonProxySettings

java.lang.Object

org.apache.pekko.cluster.singleton.ClusterSingletonProxySettings

All Implemented Interfaces:

NoSerializationVerificationNeeded

public final class ClusterSingletonProxySettings
extends Object
implements NoSerializationVerificationNeeded

param: singletonName The actor name of the singleton actor that is started by the ClusterSingletonManager. param: role The role of the cluster nodes where the singleton can be deployed. Corresponding to the role used by the ClusterSingletonManager. If the role is not specified it's a singleton among all nodes in the cluster, and the ClusterSingletonManager must then also be configured in same way. param: dataCenter The data center of the cluster nodes where the singleton is running. If None then the same data center as current node. param: singletonIdentificationInterval Interval at which the proxy will try to resolve the singleton instance. param: bufferSize If the location of the singleton is unknown the proxy will buffer this number of messages and deliver them when the singleton is identified. When the buffer is full old messages will be dropped when new messages are sent viea the proxy. Use 0 to disable buffering, i.e. messages will be dropped immediately if the location of the singleton is unknown.

Constructor Summary

Constructors

Constructor	Description
ClusterSingletonProxySettings(String singletonName, scala.Option<String> role, scala.concurrent.duration.FiniteDuration singletonIdentificationInterval, int bufferSize)
ClusterSingletonProxySettings(String singletonName, scala.Option<String> role, scala.Option<String> dataCenter, scala.concurrent.duration.FiniteDuration singletonIdentificationInterval, int bufferSize)

Method Summary

Modifier and Type	Method	Description
static ClusterSingletonProxySettings	apply(com.typesafe.config.Config config)	Create settings from a configuration with the same layout as the default configuration pekko.cluster.singleton-proxy.
static ClusterSingletonProxySettings	apply(ActorSystem system)	Create settings from the default configuration pekko.cluster.singleton-proxy.
int	bufferSize()
static ClusterSingletonProxySettings	create(com.typesafe.config.Config config)	Java API: Create settings from a configuration with the same layout as the default configuration pekko.cluster.singleton-proxy.
static ClusterSingletonProxySettings	create(ActorSystem system)	Java API: Create settings from the default configuration pekko.cluster.singleton-proxy.
scala.Option<String>	dataCenter()
scala.Option<String>	role()
scala.concurrent.duration.FiniteDuration	singletonIdentificationInterval()
String	singletonName()
ClusterSingletonProxySettings	withBufferSize(int bufferSize)
ClusterSingletonProxySettings	withDataCenter(String dataCenter)
ClusterSingletonProxySettings	withDataCenter(scala.Option<String> dataCenter)
ClusterSingletonProxySettings	withRole(String role)
ClusterSingletonProxySettings	withRole(scala.Option<String> role)
ClusterSingletonProxySettings	withSingletonIdentificationInterval(scala.concurrent.duration.FiniteDuration singletonIdentificationInterval)
ClusterSingletonProxySettings	withSingletonName(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClusterSingletonProxySettings

public ClusterSingletonProxySettings(String singletonName,
 scala.Option<String> role,
 scala.Option<String> dataCenter,
 scala.concurrent.duration.FiniteDuration singletonIdentificationInterval,
 int bufferSize)

ClusterSingletonProxySettings

public ClusterSingletonProxySettings(String singletonName,
 scala.Option<String> role,
 scala.concurrent.duration.FiniteDuration singletonIdentificationInterval,
 int bufferSize)

Method Details

apply

public static ClusterSingletonProxySettings apply(ActorSystem system)

Create settings from the default configuration pekko.cluster.singleton-proxy.

apply

public static ClusterSingletonProxySettings apply(com.typesafe.config.Config config)

Create settings from a configuration with the same layout as the default configuration pekko.cluster.singleton-proxy.

create

public static ClusterSingletonProxySettings create(ActorSystem system)

Java API: Create settings from the default configuration pekko.cluster.singleton-proxy.

create

public static ClusterSingletonProxySettings create(com.typesafe.config.Config config)

Java API: Create settings from a configuration with the same layout as the default configuration pekko.cluster.singleton-proxy.

singletonName

public String singletonName()

role

public scala.Option<String> role()

dataCenter

public scala.Option<String> dataCenter()

singletonIdentificationInterval

public scala.concurrent.duration.FiniteDuration singletonIdentificationInterval()

bufferSize

public int bufferSize()

withSingletonName

public ClusterSingletonProxySettings withSingletonName(String name)

withRole

public ClusterSingletonProxySettings withRole(String role)

withRole

public ClusterSingletonProxySettings withRole(scala.Option<String> role)

withDataCenter

public ClusterSingletonProxySettings withDataCenter(String dataCenter)

withDataCenter

public ClusterSingletonProxySettings withDataCenter(scala.Option<String> dataCenter)

withSingletonIdentificationInterval

public ClusterSingletonProxySettings withSingletonIdentificationInterval(scala.concurrent.duration.FiniteDuration singletonIdentificationInterval)

withBufferSize

public ClusterSingletonProxySettings withBufferSize(int bufferSize)