akka.cluster.routing

ClusterRouterConfig

final case class ClusterRouterConfig(local: RouterConfig, settings: ClusterRouterSettings) extends RouterConfig with Product with Serializable

akka.routing.RouterConfig implementation for deployment on cluster nodes. Delegates other duties to the local akka.routing.RouterConfig, which makes it possible to mix this with the built-in routers such as akka.routing.RoundRobinRouter or custom routers.

Annotations
@SerialVersionUID( 1L )
Linear Supertypes
Serializable, Serializable, Product, Equals, RouterConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ClusterRouterConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RouterConfig
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClusterRouterConfig(local: RouterConfig, settings: ClusterRouterSettings)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ClusterRouterConfig, B)

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to ArrowAssoc[ClusterRouterConfig] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def createActor(): Router

    The router "head" actor.

    The router "head" actor.

    Definition Classes
    ClusterRouterConfigRouterConfig
  11. def createRoute(routeeProvider: RouteeProvider): Route

    Implement the routing logic by returning a partial function of partial function from (sender, message) to a set of destinations.

    Implement the routing logic by returning a partial function of partial function from (sender, message) to a set of destinations. This Route will be applied for each incoming message.

    When createRoute is called the routees should also be registered, typically by using createRoutees or registerRouteesFor of the supplied RouteeProvider.

    Definition Classes
    ClusterRouterConfigRouterConfig
  12. def createRouteeProvider(context: ActorContext, routeeProps: Props): ClusterRouteeProvider

    The RouteeProvider responsible for creating or looking up routees.

    The RouteeProvider responsible for creating or looking up routees. It's used in createRoute to register routees, and also from akka.routing.Resizer.

    Definition Classes
    ClusterRouterConfigRouterConfig
  13. def ensuring(cond: (ClusterRouterConfig) ⇒ Boolean, msg: ⇒ Any): ClusterRouterConfig

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to Ensuring[ClusterRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (ClusterRouterConfig) ⇒ Boolean): ClusterRouterConfig

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to Ensuring[ClusterRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): ClusterRouterConfig

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to Ensuring[ClusterRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): ClusterRouterConfig

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to Ensuring[ClusterRouterConfig] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. def finalize(): Unit

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

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. val local: RouterConfig

  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. def resizer: Option[Resizer]

    Routers with dynamically resizable number of routees return the akka.routing.Resizer to use.

    Routers with dynamically resizable number of routees return the akka.routing.Resizer to use. The resizer is invoked once when the router is created, before any messages can be sent to it. Resize is also triggered when messages are sent to the routees, and the resizer is invoked asynchronously, i.e. not necessarily before the message has been sent.

    Definition Classes
    ClusterRouterConfigRouterConfig
  27. def routerDispatcher: String

    Dispatcher ID to use for running the “head” actor, i.

    Dispatcher ID to use for running the “head” actor, i.e. the akka.routing.Router.

    Definition Classes
    ClusterRouterConfigRouterConfig
  28. val settings: ClusterRouterSettings

  29. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    ClusterRouterConfigRouterConfig
  30. def supervisorStrategy: SupervisorStrategy

    SupervisorStrategy for the created Router actor.

    SupervisorStrategy for the created Router actor.

    Definition Classes
    ClusterRouterConfigRouterConfig
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toAll(sender: ActorRef, routees: Iterable[ActorRef]): Iterable[Destination]

    Attributes
    protected
    Definition Classes
    RouterConfig
  33. def verifyConfig(path: ActorPath): Unit

    Check that everything is there which is needed.

    Check that everything is there which is needed. Called in constructor of RoutedActorRef to fail early.

    Definition Classes
    RouterConfig
  34. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def withFallback(other: RouterConfig): RouterConfig

    Overridable merge strategy, by default completely prefers “this” (i.

    Overridable merge strategy, by default completely prefers “this” (i.e. no merge).

    Definition Classes
    ClusterRouterConfigRouterConfig
  38. def [B](y: B): (ClusterRouterConfig, B)

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to ArrowAssoc[ClusterRouterConfig] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterRouterConfig: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterRouterConfig: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ClusterRouterConfig

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to ArrowAssoc[ClusterRouterConfig] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterRouterConfig: ArrowAssoc[ClusterRouterConfig]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ClusterRouterConfig

    Implicit information
    This member is added by an implicit conversion from ClusterRouterConfig to Ensuring[ClusterRouterConfig] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (clusterRouterConfig: Ensuring[ClusterRouterConfig]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RouterConfig

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterRouterConfig to StringAdd

Inherited by implicit conversion any2stringfmt from ClusterRouterConfig to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ClusterRouterConfig to ArrowAssoc[ClusterRouterConfig]

Inherited by implicit conversion any2Ensuring from ClusterRouterConfig to Ensuring[ClusterRouterConfig]

Ungrouped