akka.contrib.throttle.Throttler

SetTarget

Related Doc: package Throttler

case class SetTarget(target: Option[ActorRef]) extends Product with Serializable

Set the target of a throttler.

You may change a throttler's target at any time.

Notice that the messages sent by the throttler to the target will have the original sender (and not the throttler) as the sender. (In Akka terms, the throttler forwards the message.)

target

if target is None, the throttler will stop delivering messages and the messages already received but not yet delivered, as well as any messages received in the future will be queued and eventually be delivered when a new target is set. If target is not None, the currently queued messages as well as any messages received in the future will be delivered to the new target at a rate not exceeding the current throttler's rate.

Source
TimerBasedThrottler.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SetTarget
  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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SetTarget(target: ActorRef)

    Java API:

    Java API:

    target

    if target is null, the throttler will stop delivering messages and the messages already received but not yet delivered, as well as any messages received in the future will be queued and eventually be delivered when a new target is set. If target is not null, the currently queued messages as well as any messages received in the future will be delivered to the new target at a rate not exceeding the current throttler's rate.

  2. new SetTarget(target: Option[ActorRef])

    target

    if target is None, the throttler will stop delivering messages and the messages already received but not yet delivered, as well as any messages received in the future will be queued and eventually be delivered when a new target is set. If target is not None, the currently queued messages as well as any messages received in the future will be delivered to the new target at a rate not exceeding the current throttler's rate.

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 information
    This member is added by an implicit conversion from SetTarget to any2stringadd[SetTarget] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

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

    Implicit information
    This member is added by an implicit conversion from SetTarget to ArrowAssoc[SetTarget] 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
    @throws( ... )

  8. def ensuring(cond: (SetTarget) ⇒ Boolean, msg: ⇒ Any): SetTarget

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

  9. def ensuring(cond: (SetTarget) ⇒ Boolean): SetTarget

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): SetTarget

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

  11. def ensuring(cond: Boolean): SetTarget

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

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

    Definition Classes
    AnyRef

  13. def finalize(): Unit

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

  14. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  21. val target: Option[ActorRef]

    if target is None, the throttler will stop delivering messages and the messages already received but not yet delivered, as well as any messages received in the future will be queued and eventually be delivered when a new target is set.

    if target is None, the throttler will stop delivering messages and the messages already received but not yet delivered, as well as any messages received in the future will be queued and eventually be delivered when a new target is set. If target is not None, the currently queued messages as well as any messages received in the future will be delivered to the new target at a rate not exceeding the current throttler's rate.

  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. def →[B](y: B): (SetTarget, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SetTarget to any2stringadd[SetTarget]

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

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

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

Ungrouped