akka.contrib.throttle

Class Throttler.SetTarget

java.lang.Object

akka.contrib.throttle.Throttler.SetTarget

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

Enclosing class:

Throttler

public static final class Throttler.SetTarget
extends java.lang.Object
implements scala.Product, scala.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.)

param: 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetTarget(ActorRef target) Java API:
SetTarget(scala.Option<ActorRef> target)

Method Summary

Modifier and Type	Method and Description
scala.Option<ActorRef>	target()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

SetTarget

public SetTarget(scala.Option<ActorRef> target)

SetTarget

public SetTarget(ActorRef target)

Java API:

Parameters:

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.

Method Detail

target

public scala.Option<ActorRef> target()