Packages

abstract class PoolRouter[T] extends DeferredBehavior[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
DeferredBehavior[T], Behavior[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PoolRouter
  2. DeferredBehavior
  3. Behavior
  4. AnyRef
  5. Any
Implicitly
  1. by BehaviorDecorators
  2. by BehaviorDecorators
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PoolRouter()

Abstract Value Members

  1. abstract def apply(ctx: TypedActorContext[T]): Behavior[T]
    Definition Classes
    DeferredBehavior
  2. abstract def withPoolSize(poolSize: Int): PoolRouter[T]

    Set a new pool size from the one set at construction

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

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to any2stringadd[PoolRouter[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PoolRouter[T], B)
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to ArrowAssoc[PoolRouter[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (PoolRouter[T]) ⇒ Boolean, msg: ⇒ Any): PoolRouter[T]
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to Ensuring[PoolRouter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (PoolRouter[T]) ⇒ Boolean): PoolRouter[T]
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to Ensuring[PoolRouter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): PoolRouter[T]
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to Ensuring[PoolRouter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): PoolRouter[T]
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to Ensuring[PoolRouter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to StringFormat[PoolRouter[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. 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
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def orElse(that: Behavior[T]): Behavior[T]

    Composes this Behavior with a fallback Behavior which is used when this Behavior doesn't handle the message or signal, i.e.

    Composes this Behavior with a fallback Behavior which is used when this Behavior doesn't handle the message or signal, i.e. when unhandled is returned.

    that

    the fallback Behavior

    Definition Classes
    Behavior
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def →[B](y: B): (PoolRouter[T], B)
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to ArrowAssoc[PoolRouter[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val behavior: Behavior[T]
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    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:
    (poolRouter: BehaviorDecorators[T]).behavior
    Definition Classes
    BehaviorDecorators
  2. val behavior: Behavior[T]
    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    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:
    (poolRouter: BehaviorDecorators[T]).behavior
    Definition Classes
    BehaviorDecorators
  3. def widen[U](matcher: PartialFunction[U, T]): Behavior[U]

    Widen the wrapped Behavior by placing a funnel in front of it: 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.

    Widen the wrapped Behavior by placing a funnel in front of it: 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:

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

    Scheduled messages via akka.actor.typed.scaladsl.TimerScheduler can currently not be used together with widen, see issue #25318.

    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    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:
    (poolRouter: BehaviorDecorators[T]).widen(matcher)
    Definition Classes
    BehaviorDecorators
  4. def widen[U](matcher: PartialFunction[U, T]): Behavior[U]

    Widen the wrapped Behavior by placing a funnel in front of it: 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.

    Widen the wrapped Behavior by placing a funnel in front of it: 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:

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

    Scheduled messages via akka.actor.typed.scaladsl.TimerScheduler can currently not be used together with widen, see issue #25318.

    Implicit
    This member is added by an implicit conversion from PoolRouter[T] to BehaviorDecorators[T] performed by method BehaviorDecorators in akka.actor.typed.Behavior.
    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:
    (poolRouter: BehaviorDecorators[T]).widen(matcher)
    Definition Classes
    BehaviorDecorators

Deprecated Value Members

  1. def finalize(): Unit
    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 DeferredBehavior[T]

Inherited from Behavior[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion BehaviorDecorators from PoolRouter[T] to BehaviorDecorators[T]

Inherited by implicit conversion BehaviorDecorators from PoolRouter[T] to BehaviorDecorators[T]

Inherited by implicit conversion any2stringadd from PoolRouter[T] to any2stringadd[PoolRouter[T]]

Inherited by implicit conversion StringFormat from PoolRouter[T] to StringFormat[PoolRouter[T]]

Inherited by implicit conversion Ensuring from PoolRouter[T] to Ensuring[PoolRouter[T]]

Inherited by implicit conversion ArrowAssoc from PoolRouter[T] to ArrowAssoc[PoolRouter[T]]

Ungrouped