Package akka.contrib.throttle

Class TimerBasedThrottler

java.lang.Object

akka.contrib.throttle.TimerBasedThrottler

All Implemented Interfaces:

Actor, ActorLogging, FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>, Listeners

public class TimerBasedThrottler
extends java.lang.Object
implements Actor, FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

Deprecated.

Use streams, see migration guide. Since 2.5.0.

Send as many messages as we can (while respecting the rate) to the target and return the state data (with the queue containing the remaining ones).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimerBasedThrottler.Active$	Deprecated.
static class	TimerBasedThrottler.Data	Deprecated.
static class	TimerBasedThrottler.Data$	Deprecated.
static class	TimerBasedThrottler.Idle$	Deprecated.
static class	TimerBasedThrottler.Message	Deprecated.
static class	TimerBasedThrottler.Message$	Deprecated.
static interface	TimerBasedThrottler.State	Deprecated.
static class	TimerBasedThrottler.Tick$	Deprecated.

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Nested classes/interfaces inherited from interface akka.actor.FSM

FSM.$minus$greater$, FSM.CurrentState<S>, FSM.CurrentState$, FSM.Event<D>, FSM.Event$, FSM.Failure, FSM.Failure$, FSM.LogEntry<S,D>, FSM.LogEntry$, FSM.Normal$, FSM.NullFunction$, FSM.Reason, FSM.Shutdown$, FSM.SilentState<S,D>, FSM.State$, FSM.StateTimeout$, FSM.StopEvent<S,D>, FSM.StopEvent$, FSM.SubscribeTransitionCallBack, FSM.SubscribeTransitionCallBack$, FSM.Timer, FSM.Timer$, FSM.TransformHelper, FSM.Transition<S>, FSM.Transition$, FSM.UnsubscribeTransitionCallBack, FSM.UnsubscribeTransitionCallBack$

Constructor Summary

Constructors

Constructor	Description
TimerBasedThrottler(Throttler.Rate rate)	Deprecated.

Method Summary

Modifier and Type	Method	Description
FSM.$minus$greater$	$minus$greater()	Deprecated. This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.
protected void	akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)	Deprecated.
protected void	akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)	Deprecated. The 'self' field holds the ActorRef for this actor.
protected void	akka$actor$FSM$_setter_$Event_$eq(FSM.Event$ x$1)	Deprecated.
protected void	akka$actor$FSM$_setter_$StateTimeout_$eq(FSM.StateTimeout$ x$1)	Deprecated. This case object is received in case of a state timeout.
protected void	akka$actor$FSM$_setter_$StopEvent_$eq(FSM.StopEvent$ x$1)	Deprecated.
protected void	akka$routing$Listeners$_setter_$listeners_$eq(java.util.Set<ActorRef> x$1)	Deprecated.
ActorContext	context()	Deprecated. Scala API: Stores the context for this actor, including self, and sender.
FSM.Event$	Event()	Deprecated.
protected java.util.Set<ActorRef>	listeners()	Deprecated.
Throttler.Rate	rate()	Deprecated.
void	rate_$eq(Throttler.Rate x$1)	Deprecated.
ActorRef	self()	Deprecated. The 'self' field holds the ActorRef for this actor.
FSM.StateTimeout$	StateTimeout()	Deprecated. This case object is received in case of a state timeout.
FSM.StopEvent$	StopEvent()	Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, postRestart, preRestart, preStart, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.actor.ActorLogging

_log_$eq, log

Methods inherited from interface akka.actor.FSM

applyState, cancelTimer, currentState_$eq, debugEvent, generation_$eq, handleEvent_$eq, handleTransition, initialize, isStateTimerActive, isTimerActive, logTermination, makeTransition, nextState_$eq, nextStateData, onTermination, onTransition, postStop, processEvent, processMsg, receive, register, setStateTimeout, setTimer, setTimer$default$4, startWith, startWith$default$3, stateData, stateName, stay, stop, stop, stop, super$postStop, terminate, terminateEvent_$eq, timeoutFuture_$eq, total2pf, transform, transitionEvent_$eq, when, when$default$2, whenUnhandled

Methods inherited from interface akka.routing.Listeners

gossip, gossip$default$2, listenerManagement

Constructor Detail

TimerBasedThrottler

public TimerBasedThrottler(Throttler.Rate rate)

Deprecated.

Method Detail

Event

public FSM.Event$ Event()

Deprecated.

Specified by:

Event in interface FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

StopEvent

public FSM.StopEvent$ StopEvent()

Deprecated.

Specified by:

StopEvent in interface FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

$minus$greater

public FSM.$minus$greater$ $minus$greater()

Deprecated.

Description copied from interface: FSM

This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.

Specified by:

$minus$greater in interface FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

Returns:

(undocumented)

StateTimeout

public FSM.StateTimeout$ StateTimeout()

Deprecated.

Description copied from interface: FSM

This case object is received in case of a state timeout.

Specified by:

StateTimeout in interface FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

Returns:

(undocumented)

akka$actor$FSM$_setter_$Event_$eq

protected void akka$actor$FSM$_setter_$Event_$eq(FSM.Event$ x$1)

Deprecated.

Specified by:

akka$actor$FSM$_setter_$Event_$eq in interface FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

akka$actor$FSM$_setter_$StopEvent_$eq

protected void akka$actor$FSM$_setter_$StopEvent_$eq(FSM.StopEvent$ x$1)

Deprecated.

Specified by:

akka$actor$FSM$_setter_$StopEvent_$eq in interface FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

akka$actor$FSM$_setter_$StateTimeout_$eq

protected void akka$actor$FSM$_setter_$StateTimeout_$eq(FSM.StateTimeout$ x$1)

Deprecated.

Description copied from interface: FSM

This case object is received in case of a state timeout.

Specified by:

akka$actor$FSM$_setter_$StateTimeout_$eq in interface FSM<TimerBasedThrottler.State,TimerBasedThrottler.Data>

Parameters:

x$1 - (undocumented)

listeners

protected java.util.Set<ActorRef> listeners()

Deprecated.

Specified by:

listeners in interface Listeners

akka$routing$Listeners$_setter_$listeners_$eq

protected void akka$routing$Listeners$_setter_$listeners_$eq(java.util.Set<ActorRef> x$1)

Deprecated.

Specified by:

akka$routing$Listeners$_setter_$listeners_$eq in interface Listeners

context

public ActorContext context()

Deprecated.

Description copied from interface: Actor

Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

ActorContext is the Scala API. getContext returns a AbstractActor.ActorContext, which is the Java API of the actor context.

Specified by:

context in interface Actor

Returns:

(undocumented)

self

public final ActorRef self()

Deprecated.

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

self in interface Actor

Returns:

(undocumented)

akka$actor$Actor$_setter_$context_$eq

protected void akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)

Deprecated.

Specified by:

akka$actor$Actor$_setter_$context_$eq in interface Actor

akka$actor$Actor$_setter_$self_$eq

protected final void akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)

Deprecated.

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

akka$actor$Actor$_setter_$self_$eq in interface Actor

Parameters:

x$1 - (undocumented)

rate

public Throttler.Rate rate()

Deprecated.

rate_$eq

public void rate_$eq(Throttler.Rate x$1)

Deprecated.