trait PoolRouter[T] extends Behavior[T]

Provides builder style configuration options for pool routers

Not for user extension. Use Routers#pool to create

Annotations
@DoNotInherit()
Source
Routers.scala
Linear Supertypes
Behavior[T], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PoolRouter
  2. Behavior
  3. AnyRef
  4. Any
Implicitly
  1. by BehaviorDecorators
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def withBroadcastPredicate(pred: (T) => Boolean): PoolRouter[T]

    Any message that the predicate returns true for will be broadcast to all routees.

  2. abstract def withConsistentHashingRouting(virtualNodesFactor: Int, mapping: (T) => String): PoolRouter[T]

    Route messages by using consistent hashing.

    Route messages by using consistent hashing.

    From wikipedia: Consistent hashing is based on mapping each object to a point on a circle (or equivalently, mapping each object to a real angle). The system maps each available machine (or other storage bucket) to many pseudo-randomly distributed points on the same circle.

    virtualNodesFactor

    This factor has to be greater or equal to 1. Assuming that the reader knows what consistent hashing is (if not, please refer: https://www.tom-e-white.com/2007/11/consistent-hashing.html or wiki). This number is responsible for creating additional, virtual addresses for a provided set of routees, so that in the total number of points on hashing ring will be equal to numberOfRoutees * virtualNodesFactor (if virtualNodesFactor is equal to 1, then no additional points will be created). Those virtual nodes are being created by additionally rehashing routees to evenly distribute them across hashing ring. Consider increasing this number when you have a small number of routees. For bigger loads one can aim in having around 100-200 total addresses.

    mapping

    Hash key extractor. This function will be used in consistent hashing process. Result of this operation should possibly uniquely distinguish messages.

  3. abstract def withPoolSize(poolSize: Int): PoolRouter[T]

    Set a new pool size from the one set at construction

  4. abstract def withRandomRouting(): PoolRouter[T]

    Route messages by randomly selecting the routee from the available routees.

    Route messages by randomly selecting the routee from the available routees.

    Random routing makes it less likely that every poolSize message from a single producer ends up in the same mailbox of a slow actor.

  5. abstract def withRoundRobinRouting(): PoolRouter[T]

    Route messages through round robin, providing a fair distribution of messages across the routees.

    Route messages through round robin, providing a fair distribution of messages across the routees.

    Round robin gives fair routing where every available routee gets the same amount of messages

    This is the default for pool routers.

  6. abstract def withRouteeProps(routeeProps: Props): PoolRouter[T]

    Set the props used to spawn the pool's routees

Concrete Value Members

  1. val behavior: Behavior[T]
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] toBehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators
  2. final def narrow[U <: T]: Behavior[U]

    Narrow the type of this Behavior, which is always a safe operation.

    Narrow the type of this Behavior, which is always a safe operation. This method is necessary to implement the contravariant nature of Behavior (which cannot be expressed directly due to type inference problems).

    Definition Classes
    Behavior
  3. def transformMessages[Outer](matcher: PartialFunction[Outer, T])(implicit arg0: ClassTag[Outer]): Behavior[Outer]

    Transform the incoming messages by placing a funnel in front of the wrapped Behavior: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy.

    Transform the incoming messages by placing a funnel in front of the wrapped Behavior: the supplied PartialFunction decides which message to pull in (those that it is defined at) and may transform the incoming message to place them into the wrapped Behavior’s type hierarchy. Signals are not transformed.

    Example:

    val b: Behavior[Number] =
  Behaviors
    .receive[String] { (ctx, msg) =>
      println(msg)
      Behaviors.same
    }
    .transformMessages[Number] {
      case b: BigDecimal => s"BigDecimal($b)"
      case i: BigInt     => s"BigInteger($i)"
      // all other kinds of Number will be `unhandled`
    }

    The ClassTag for Outer ensures that only messages of this class or a subclass thereof will be intercepted. Other message types (e.g. a private protocol) will bypass the interceptor and be continue to the inner behavior untouched.

    Implicit
    This member is added by an implicit conversion from PoolRouter[T] toBehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    Definition Classes
    BehaviorDecorators