akka.routing

Router

final case class Router(logic: RoutingLogic, routees: IndexedSeq[Routee] = ...) extends Product with Serializable

For each message that is sent through the router via the #route method the RoutingLogic decides to which Routee to send the message. The Routee itself knows how to perform the actual sending. Normally the RoutingLogic picks one of the contained routees, but that is up to the implementation of the RoutingLogic.

A Router is immutable and the RoutingLogic must be thread safe.

Source
Router.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Router
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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 Router(logic: RoutingLogic, routees: Iterable[Routee])

    Java API

  2. new Router(logic: RoutingLogic)

    Java API

  3. new Router(logic: RoutingLogic, routees: IndexedSeq[Routee] = ...)

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

    Implicit information
    This member is added by an implicit conversion from Router to ArrowAssoc[Router] 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. def addRoutee(sel: ActorSelection): Router

    Create a new instance with one more ActorSelectionRoutee for the specified akka.actor.ActorSelection and the same RoutingLogic.

  9. def addRoutee(ref: ActorRef): Router

    Create a new instance with one more ActorRefRoutee for the specified akka.actor.ActorRef and the same RoutingLogic.

  10. def addRoutee(routee: Routee): Router

    Create a new instance with one more routee and the same RoutingLogic.

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def clone(): AnyRef

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from Router to Ensuring[Router] 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 Router 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 logic: RoutingLogic

  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 removeRoutee(sel: ActorSelection): Router

    Create a new instance without the ActorSelectionRoutee for the specified akka.actor.ActorSelection.

  27. def removeRoutee(ref: ActorRef): Router

    Create a new instance without the ActorRefRoutee for the specified akka.actor.ActorRef.

  28. def removeRoutee(routee: Routee): Router

    Create a new instance without the specified routee.

  29. def route(message: Any, sender: ActorRef): Unit

    Send the message to the destination Routee selected by the RoutingLogic.

    Send the message to the destination Routee selected by the RoutingLogic. If the message is a akka.routing.RouterEnvelope it will be unwrapped before sent to the destinations. Messages wrapped in a Broadcast envelope are always sent to all routees.

  30. val routees: IndexedSeq[Routee]

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

    Definition Classes
    AnyRef
  32. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withRoutees(rs: IndexedSeq[Routee]): Router

    Create a new instance with the specified routees and the same RoutingLogic.

  36. def [B](y: B): (Router, B)

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

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

Deprecated Value Members

  1. def x: Router

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Router

    Implicit information
    This member is added by an implicit conversion from Router to Ensuring[Router] 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:
    (router: Ensuring[Router]).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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Router to StringAdd

Inherited by implicit conversion any2stringfmt from Router to StringFormat

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

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

Ungrouped