akka.routing

CustomRouterConfig

abstract class CustomRouterConfig extends RouterConfig

If a custom router implementation is not a Group nor a Pool it may extend this base class.

Source
RouterConfig.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CustomRouterConfig
  2. RouterConfig
  3. Serializable
  4. Serializable
  5. AnyRef
  6. 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 CustomRouterConfig()

Abstract Value Members

  1. abstract def createRouter(system: ActorSystem): Router

    Create the actual router, responsible for routing messages to routees.

    Create the actual router, responsible for routing messages to routees.

    system

    the ActorSystem this router belongs to

    Definition Classes
    RouterConfig

Concrete 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 CustomRouterConfig to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (CustomRouterConfig, B)

    Implicit information
    This member is added by an implicit conversion from CustomRouterConfig to ArrowAssoc[CustomRouterConfig] 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 ensuring(cond: (CustomRouterConfig) ⇒ Boolean, msg: ⇒ Any): CustomRouterConfig

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

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

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

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

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

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

    Definition Classes
    Any
  21. def isManagementMessage(msg: Any): Boolean

    Is the message handled by the router head actor or the #routingLogicController actor.

    Is the message handled by the router head actor or the #routingLogicController actor.

    Definition Classes
    RouterConfig
  22. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  25. def routerDispatcher: String

    Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

    Dispatcher ID to use for running the “head” actor, which handles supervision, death watch and router management messages

    Definition Classes
    CustomRouterConfigRouterConfig
  26. def routingLogicController(routingLogic: RoutingLogic): Option[Props]

    Possibility to define an actor for controlling the routing logic from external stimuli (e.

    Possibility to define an actor for controlling the routing logic from external stimuli (e.g. monitoring metrics). This actor will be a child of the router "head" actor. Managment messages not handled by the "head" actor are delegated to this controller actor.

    Definition Classes
    RouterConfig
  27. def stopRouterWhenAllRouteesRemoved: Boolean

    Definition Classes
    RouterConfig
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. def toString(): String

    Definition Classes
    AnyRef → Any
  30. 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
  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. 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
    RouterConfig
  35. def [B](y: B): (CustomRouterConfig, B)

    Implicit information
    This member is added by an implicit conversion from CustomRouterConfig to ArrowAssoc[CustomRouterConfig] 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 CustomRouterConfig 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:
    (customRouterConfig: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from CustomRouterConfig 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:
    (customRouterConfig: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: CustomRouterConfig

    Implicit information
    This member is added by an implicit conversion from CustomRouterConfig to ArrowAssoc[CustomRouterConfig] 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:
    (customRouterConfig: ArrowAssoc[CustomRouterConfig]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: CustomRouterConfig

    Implicit information
    This member is added by an implicit conversion from CustomRouterConfig to Ensuring[CustomRouterConfig] 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:
    (customRouterConfig: Ensuring[CustomRouterConfig]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from RouterConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CustomRouterConfig to StringAdd

Inherited by implicit conversion any2stringfmt from CustomRouterConfig to StringFormat

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

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

Ungrouped