Class

akka.routing

Router

Related Doc: package routing

Permalink

final case class Router(logic: RoutingLogic, routees: IndexedSeq[Routee] = Vector.empty) 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
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Router(logic: RoutingLogic, routees: Iterable[Routee])

    Permalink

    Java API

  2. new Router(logic: RoutingLogic)

    Permalink

    Java API

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

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Router to any2stringadd[Router] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Router, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Router to ArrowAssoc[Router] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. def addRoutee(sel: ActorSelection): Router

    Permalink

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

  7. def addRoutee(ref: ActorRef): Router

    Permalink

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

  8. def addRoutee(routee: Routee): Router

    Permalink

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

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  11. def ensuring(cond: (Router) ⇒ Boolean, msg: ⇒ Any): Router

    Permalink
    Implicit information
    This member is added by an implicit conversion from Router to Ensuring[Router] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (Router) ⇒ Boolean): Router

    Permalink
    Implicit information
    This member is added by an implicit conversion from Router to Ensuring[Router] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): Router

    Permalink
    Implicit information
    This member is added by an implicit conversion from Router to Ensuring[Router] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): Router

    Permalink
    Implicit information
    This member is added by an implicit conversion from Router to Ensuring[Router] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Router to StringFormat[Router] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. val logic: RoutingLogic

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  23. def removeRoutee(sel: ActorSelection): Router

    Permalink

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

  24. def removeRoutee(ref: ActorRef): Router

    Permalink

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

  25. def removeRoutee(routee: Routee): Router

    Permalink

    Create a new instance without the specified routee.

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

    Permalink

    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.

  27. val routees: IndexedSeq[Routee]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def withRoutees(rs: IndexedSeq[Routee]): Router

    Permalink

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

  33. def →[B](y: B): (Router, B)

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

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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 any2stringadd[Router]

Inherited by implicit conversion StringFormat from Router to StringFormat[Router]

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

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

Ungrouped