akka.cluster.routing
Class ClusterRouterSettings

java.lang.Object
  akka.cluster.routing.ClusterRouterSettings

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class ClusterRouterSettings
extends java.lang.Object
implements scala.Product, scala.Serializable

totalInstances of cluster router must be > 0 maxInstancesPerNode of cluster router must be > 0 maxInstancesPerNode of cluster router must be 1 when routeesPath is defined

See Also:

Serialized Form

Constructor Summary

ClusterRouterSettings(int totalInstances, int maxInstancesPerNode, boolean allowLocalRoutees, java.lang.String useRole)
Java API: Settings for create and deploy of the routees

ClusterRouterSettings(int totalInstances, java.lang.String routeesPath, boolean allowLocalRoutees, java.lang.String useRole)
Java API: Settings for lookup of the routees

Method Summary

boolean	allowLocalRoutees()
static ClusterRouterSettings	apply(int totalInstances, int maxInstancesPerNode, boolean allowLocalRoutees, scala.Option<java.lang.String> useRole) Settings for create and deploy of the routees
static ClusterRouterSettings	apply(int totalInstances, int maxInstancesPerNode, scala.Option<java.lang.String> useRole) Settings for remote deployment of the routees, allowed to use routees on own node
static ClusterRouterSettings	apply(int totalInstances, java.lang.String routeesPath, boolean allowLocalRoutees, scala.Option<java.lang.String> useRole) Settings for lookup of the routees
static ClusterRouterSettings	apply(int totalInstances, java.lang.String routeesPath, scala.Option<java.lang.String> useRole) Settings for lookup of the routees, allowed to use routees on own node
boolean	isRouteesPathDefined()
int	maxInstancesPerNode()
java.lang.String	routeesPath()
scala.collection.immutable.Iterable<java.lang.String>	routeesPathElements()
int	totalInstances()
scala.Option<java.lang.String>	useRole()
static scala.Option<java.lang.String>	useRoleOption(java.lang.String role)

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ClusterRouterSettings

public ClusterRouterSettings(int totalInstances,
                             int maxInstancesPerNode,
                             boolean allowLocalRoutees,
                             java.lang.String useRole)

Java API: Settings for create and deploy of the routees

ClusterRouterSettings

public ClusterRouterSettings(int totalInstances,
                             java.lang.String routeesPath,
                             boolean allowLocalRoutees,
                             java.lang.String useRole)

Java API: Settings for lookup of the routees

Method Detail

apply

public static ClusterRouterSettings apply(int totalInstances,
                                          int maxInstancesPerNode,
                                          boolean allowLocalRoutees,
                                          scala.Option<java.lang.String> useRole)

Settings for create and deploy of the routees

apply

public static ClusterRouterSettings apply(int totalInstances,
                                          int maxInstancesPerNode,
                                          scala.Option<java.lang.String> useRole)

Settings for remote deployment of the routees, allowed to use routees on own node

apply

public static ClusterRouterSettings apply(int totalInstances,
                                          java.lang.String routeesPath,
                                          boolean allowLocalRoutees,
                                          scala.Option<java.lang.String> useRole)

Settings for lookup of the routees

apply

public static ClusterRouterSettings apply(int totalInstances,
                                          java.lang.String routeesPath,
                                          scala.Option<java.lang.String> useRole)

Settings for lookup of the routees, allowed to use routees on own node

useRoleOption

public static scala.Option<java.lang.String> useRoleOption(java.lang.String role)

totalInstances

public int totalInstances()

maxInstancesPerNode

public int maxInstancesPerNode()

routeesPath

public java.lang.String routeesPath()

allowLocalRoutees

public boolean allowLocalRoutees()

useRole

public scala.Option<java.lang.String> useRole()

routeesPathElements

public scala.collection.immutable.Iterable<java.lang.String> routeesPathElements()

isRouteesPathDefined

public boolean isRouteesPathDefined()