akka

routing

package routing

Content Hierarchy Learn more about scaladoc diagrams
Visibility
  1. Public
  2. All

Type Members

  1. case class ActorRefRoutee(ref: ActorRef) extends Routee with Product with Serializable

    Routee that sends the messages to an akka.actor.ActorRef.

  2. case class ActorSelectionRoutee(selection: ActorSelection) extends Routee with Product with Serializable

    Routee that sends the messages to an akka.actor.ActorSelection.

  3. case class AddRoutee(routee: Routee) extends RouterManagementMesssage with Product with Serializable

    Add a routee by sending this message to the router.

  4. case class AdjustPoolSize(change: Int) extends RouterManagementMesssage with Product with Serializable

    Increase or decrease the number of routees in a Pool.

  5. final case class BalancingPool(nrOfInstances: Int, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ...) extends Pool with Product with Serializable

    A router pool that will try to redistribute work from busy routees to idle routees.

  6. case class Broadcast(message: Any) extends RouterEnvelope with Product with Serializable

    Used to broadcast a message to all routees in a router; only the contained message will be forwarded, i.

  7. final case class BroadcastGroup(paths: Iterable[String], routerDispatcher: String = ...) extends Group with Product with Serializable

    A router group that broadcasts a message to all its routees.

  8. final case class BroadcastPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[BroadcastPool] with Product with Serializable

    A router pool that broadcasts a message to all its routees.

  9. final class BroadcastRoutingLogic extends RoutingLogic

    Broadcasts a message to all its routees.

  10. class ConsistentHash[T] extends AnyRef

    Consistent Hashing node ring implementation.

  11. final case class ConsistentHashingGroup(paths: Iterable[String], virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ..., routerDispatcher: String = ...) extends Group with Product with Serializable

    A router group that uses consistent hashing to select a routee based on the sent message.

  12. final case class ConsistentHashingPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[ConsistentHashingPool] with Product with Serializable

    A router pool that uses consistent hashing to select a routee based on the sent message.

  13. final case class ConsistentHashingRoutingLogic(system: ActorSystem, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...) extends RoutingLogic with Product with Serializable

    Uses consistent hashing to select a routee based on the sent message.

  14. abstract class CustomRouterConfig extends RouterConfig

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

  15. case class Deafen(listener: ActorRef) extends ListenerMessage with Product with Serializable

  16. case class DefaultResizer(lowerBound: Int = 1, upperBound: Int = 10, pressureThreshold: Int = 1, rampupRate: Double = 0.2, backoffThreshold: Double = 0.3, backoffRate: Double = 0.1, messagesPerResize: Int = 10) extends Resizer with Product with Serializable

    Implementation of Resizer that adjust the Pool based on specified thresholds.

  17. class FromConfig extends Pool

    Java API: Router configuration which has no default, i.

  18. abstract class GetRoutees extends RouterManagementMesssage

    Sending this message to a router will make it send back its currently used routees.

  19. trait Group extends RouterConfig

    RouterConfig for router actor with routee actors that are created external to the router and the router sends messages to the specified path using actor selection, without watching for termination.

  20. abstract class GroupBase extends Group

    Java API: Base class for custom router Group

  21. case class Listen(listener: ActorRef) extends ListenerMessage with Product with Serializable

  22. sealed trait ListenerMessage extends AnyRef

  23. trait Listeners extends AnyRef

    Listeners is a generic trait to implement listening capability on an Actor.

  24. abstract class NoRouter extends RouterConfig

    Routing configuration that indicates no routing; this is also the default value which hence overrides the merge strategy in order to accept values from lower-precedence sources.

  25. trait Pool extends RouterConfig

    RouterConfig for router actor that creates routees as child actors and removes them from the router if they terminate.

  26. abstract class PoolBase extends Pool

    Java API: Base class for custom router Pool

  27. final case class RandomGroup(paths: Iterable[String], routerDispatcher: String = ...) extends Group with Product with Serializable

    A router group that randomly selects one of the target routees to send a message to.

  28. final case class RandomPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[RandomPool] with Product with Serializable

    A router pool that randomly selects one of the target routees to send a message to.

  29. final class RandomRoutingLogic extends RoutingLogic

    Randomly selects one of the target routees to send a message to

  30. case class RemoveRoutee(routee: Routee) extends RouterManagementMesssage with Product with Serializable

    Remove a specific routee by sending this message to the router.

  31. trait Resizer extends AnyRef

    Pool routers with dynamically resizable number of routees are implemented by providing a Resizer implementation in the akka.routing.Pool configuration.

  32. final case class RoundRobinGroup(paths: Iterable[String], routerDispatcher: String = ...) extends Group with Product with Serializable

    A router group that uses round-robin to select a routee.

  33. final case class RoundRobinPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[RoundRobinPool] with Product with Serializable

    A router pool that uses round-robin to select a routee.

  34. final class RoundRobinRoutingLogic extends RoutingLogic

    Uses round-robin to select a routee.

  35. trait Routee extends AnyRef

    Abstraction of a destination for messages routed via a Router.

  36. case class Routees(routees: IndexedSeq[Routee]) extends Product with Serializable

    Message used to carry information about what routees the router is currently using.

  37. 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.

  38. trait RouterConfig extends Serializable

    This trait represents a router factory: it produces the actual router actor and creates the routing table (a function which determines the recipients for each message which is to be dispatched).

  39. trait RouterEnvelope extends AnyRef

    Only the contained message will be forwarded to the destination, i.

  40. trait RoutingLogic extends NoSerializationVerificationNeeded

    The interface of the routing logic that is used in a Router to select destination routed messages.

  41. final case class ScatterGatherFirstCompletedGroup(paths: Iterable[String], within: FiniteDuration, routerDispatcher: String = ...) extends Group with Product with Serializable

    A router group that broadcasts the message to all routees, and replies with the first response.

  42. final case class ScatterGatherFirstCompletedPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, within: FiniteDuration, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[ScatterGatherFirstCompletedPool] with Product with Serializable

    A router pool that broadcasts the message to all routees, and replies with the first response.

  43. final case class ScatterGatherFirstCompletedRoutingLogic(within: FiniteDuration) extends RoutingLogic with Product with Serializable

    Broadcasts the message to all routees, and replies with the first response.

  44. case class SeveralRoutees(routees: IndexedSeq[Routee]) extends Routee with Product with Serializable

    Routee that sends each message to all routees.

  45. final case class SmallestMailboxPool(nrOfInstances: Int, resizer: Option[Resizer] = scala.None, supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, routerDispatcher: String = ..., usePoolDispatcher: Boolean = false) extends Pool with PoolOverrideUnsetConfig[SmallestMailboxPool] with Product with Serializable

    A router pool that tries to send to the non-suspended routee with fewest messages in mailbox.

  46. class SmallestMailboxRoutingLogic extends RoutingLogic

    Tries to send to the non-suspended routee with fewest messages in mailbox.

  47. case class WithListeners(f: (ActorRef) ⇒ Unit) extends ListenerMessage with Product with Serializable

  48. case class BroadcastRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[BroadcastRouter] with Product with Serializable

    A Router that uses broadcasts a message to all its connections.

  49. case class ConsistentHashingRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy, virtualNodesFactor: Int = 0, hashMapping: ConsistentHashMapping = ...) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[ConsistentHashingRouter] with Product with Serializable

    A Router that uses consistent hashing to select a connection based on the sent message.

  50. abstract class CurrentRoutees extends RouterManagementMesssage

    Sending this message to a router will make it send back its currently used routees.

  51. trait DeprecatedRouterConfig extends Group with Pool

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use Pool or Group

  52. case class RandomRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[RandomRouter] with Product with Serializable

    A Router that randomly selects one of the target connections to send a message to.

  53. case class RoundRobinRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[RoundRobinRouter] with Product with Serializable

    A Router that uses round-robin to select a connection.

  54. case class RouterRoutees(routees: IndexedSeq[ActorRef]) extends Product with Serializable

    Message used to carry information about what routees the router is currently using.

  55. case class ScatterGatherFirstCompletedRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, within: FiniteDuration, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[ScatterGatherFirstCompletedRouter] with Product with Serializable

    Simple router that broadcasts the message to all routees, and replies with the first response.

  56. case class SmallestMailboxRouter(nrOfInstances: Int = 0, routees: Iterable[String] = immutable.this.Nil, resizer: Option[Resizer] = scala.None, routerDispatcher: String = ..., supervisorStrategy: SupervisorStrategy = Pool.defaultSupervisorStrategy) extends DeprecatedRouterConfig with PoolOverrideUnsetConfig[SmallestMailboxRouter] with Product with Serializable

    A Router that tries to send to the non-suspended routee with fewest messages in mailbox.

Value Members

  1. object BroadcastRoutingLogic

  2. object ConsistentHash

  3. object ConsistentHashingRouter extends Serializable

  4. object ConsistentHashingRoutingLogic extends Serializable

  5. object DefaultResizer extends Product with Serializable

  6. object FromConfig extends FromConfig with Product with Serializable

    Router configuration which has no default, i.

  7. object GetRoutees extends GetRoutees with Product with Serializable

    Annotations
    @SerialVersionUID( 1L )
  8. object MurmurHash

    An object designed to generate well-distributed non-cryptographic hashes.

  9. object NoRoutee extends Routee

    Routee that doesn't send the message to any routee.

  10. object NoRouter extends NoRouter with Product with Serializable

  11. object Pool extends Serializable

  12. object RandomRoutingLogic

  13. object RoundRobinRoutingLogic

  14. object SmallestMailboxRoutingLogic

Deprecated Value Members

  1. object BroadcastRouter extends Serializable

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use BroadcastPool or BroadcastGroup

  2. object CurrentRoutees extends CurrentRoutees with Product with Serializable

    Annotations
    @deprecated @SerialVersionUID( 1L )
    Deprecated

    (Since version 2.3) Use GetRoutees

  3. object RandomRouter extends Serializable

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use RandomPool or RandomGroup

  4. object RoundRobinRouter extends Serializable

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use RoundRobinPool or RoundRobinGroup

  5. object ScatterGatherFirstCompletedRouter extends Serializable

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use ScatterGatherFirstCompletedPool or ScatterGatherFirstCompletedGroup

  6. object SmallestMailboxRouter extends Serializable

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use SmallestMailboxPool

Ungrouped