Package akka.remote.transport

Class ThrottledAssociation

java.lang.Object

akka.remote.transport.ThrottledAssociation

All Implemented Interfaces:

Actor, ActorLogging, FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>, LoggingFSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>, RequiresMessageQueue<UnboundedMessageQueueSemantics>, Listeners

public class ThrottledAssociation
extends java.lang.Object
implements Actor, LoggingFSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>, RequiresMessageQueue<UnboundedMessageQueueSemantics>

INTERNAL API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThrottledAssociation.Dequeue$
static class	ThrottledAssociation.ExposedHandle
static class	ThrottledAssociation.ExposedHandle$
static class	ThrottledAssociation.FailWith
static class	ThrottledAssociation.FailWith$
static interface	ThrottledAssociation.ThrottlerData
static interface	ThrottledAssociation.ThrottlerState
static class	ThrottledAssociation.Throttling$
static class	ThrottledAssociation.Uninitialized$
static class	ThrottledAssociation.WaitExposedHandle$
static class	ThrottledAssociation.WaitMode$
static class	ThrottledAssociation.WaitModeAndUpstreamListener$
static class	ThrottledAssociation.WaitOrigin$
static class	ThrottledAssociation.WaitUpstreamListener$

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.FixedDelayMode$, FSM.FixedRateMode$, FSM.LogEntry<S,D>, FSM.LogEntry$, FSM.Normal$, FSM.NullFunction$, FSM.Reason, FSM.Shutdown$, FSM.SilentState<S,D>, FSM.SingleMode$, FSM.State<S,D>, FSM.State$, FSM.StateTimeout$, FSM.StopEvent<S,D>, FSM.StopEvent$, FSM.SubscribeTransitionCallBack, FSM.SubscribeTransitionCallBack$, FSM.Timer, FSM.Timer$, FSM.TimerMode, FSM.TransformHelper, FSM.Transition<S>, FSM.Transition$, FSM.UnsubscribeTransitionCallBack, FSM.UnsubscribeTransitionCallBack$

Constructor Summary

Constructors

Constructor	Description
ThrottledAssociation(ActorRef manager, Transport.AssociationEventListener associationHandler, AssociationHandle originalHandle, boolean inbound)

Method Summary

Modifier and Type	Method	Description
FSM.$minus$greater$	$minus$greater()	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)	Scala API: Stores the context for this actor, including self, and sender.
protected void	akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)	The 'self' field holds the ActorRef for this actor.
protected void	akka$actor$FSM$_setter_$Event_$eq(FSM.Event$ x$1)
protected void	akka$actor$FSM$_setter_$StateTimeout_$eq(FSM.StateTimeout$ x$1)	This case object is received in case of a state timeout.
protected void	akka$actor$FSM$_setter_$StopEvent_$eq(FSM.StopEvent$ x$1)
protected void	akka$actor$LoggingFSM$_setter_$debugEvent_$eq(boolean x$1)
protected void	akka$routing$Listeners$_setter_$listeners_$eq(java.util.Set<ActorRef> x$1)
Transport.AssociationEventListener	associationHandler()
ActorContext	context()	Scala API: Stores the context for this actor, including self, and sender.
boolean	debugEvent()
FSM.Event$	Event()
void	forwardOrDelay(ByteString payload)
boolean	inbound()
ThrottlerTransportAdapter.ThrottleMode	inboundThrottleMode()
void	inboundThrottleMode_$eq(ThrottlerTransportAdapter.ThrottleMode x$1)
protected java.util.Set<ActorRef>	listeners()
ActorRef	manager()
AssociationHandle	originalHandle()
void	postStop()	User overridable callback.
void	scheduleDequeue(scala.concurrent.duration.FiniteDuration delay)
ActorRef	self()	The 'self' field holds the ActorRef for this actor.
FSM.StateTimeout$	StateTimeout()	This case object is received in case of a state timeout.
FSM.StopEvent$	StopEvent()
scala.collection.immutable.Queue<ByteString>	throttledMessages()
void	throttledMessages_$eq(scala.collection.immutable.Queue<ByteString> x$1)
AssociationHandle.HandleEventListener	upstreamListener()
void	upstreamListener_$eq(AssociationHandle.HandleEventListener x$1)

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, generation_$eq, handleEvent_$eq, handleTransition, initialize, isStateTimerActive, isTimerActive, logTermination, makeTransition, nextState_$eq, nextStateData, onTermination, onTransition, processMsg, receive, register, setStateTimeout, setTimer, setTimer$default$4, startSingleTimer, startTimer, startTimerAtFixedRate, startTimerWithFixedDelay, 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

Methods inherited from interface akka.actor.LoggingFSM

advance, full_$eq, getLog, logDepth, pos_$eq, processEvent, super$processEvent

Constructor Detail

ThrottledAssociation

public ThrottledAssociation(ActorRef manager,
                            Transport.AssociationEventListener associationHandler,
                            AssociationHandle originalHandle,
                            boolean inbound)

Method Detail

debugEvent

public boolean debugEvent()

Specified by:

debugEvent in interface FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

Specified by:

debugEvent in interface LoggingFSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

akka$actor$LoggingFSM$_setter_$debugEvent_$eq

protected void akka$actor$LoggingFSM$_setter_$debugEvent_$eq(boolean x$1)

Specified by:

akka$actor$LoggingFSM$_setter_$debugEvent_$eq in interface LoggingFSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

Event

public FSM.Event$ Event()

Specified by:

Event in interface FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

StopEvent

public FSM.StopEvent$ StopEvent()

Specified by:

StopEvent in interface FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

$minus$greater

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

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<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

StateTimeout

public FSM.StateTimeout$ StateTimeout()

Description copied from interface: FSM

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

Specified by:

StateTimeout in interface FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

akka$actor$FSM$_setter_$Event_$eq

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

Specified by:

akka$actor$FSM$_setter_$Event_$eq in interface FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

akka$actor$FSM$_setter_$StopEvent_$eq

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

Specified by:

akka$actor$FSM$_setter_$StopEvent_$eq in interface FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

akka$actor$FSM$_setter_$StateTimeout_$eq

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

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<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

listeners

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

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)

Specified by:

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

context

public ActorContext context()

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

self

public final ActorRef self()

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

akka$actor$Actor$_setter_$context_$eq

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

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:

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)

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

manager

public ActorRef manager()

associationHandler

public Transport.AssociationEventListener associationHandler()

originalHandle

public AssociationHandle originalHandle()

inbound

public boolean inbound()

inboundThrottleMode

public ThrottlerTransportAdapter.ThrottleMode inboundThrottleMode()

inboundThrottleMode_$eq

public void inboundThrottleMode_$eq(ThrottlerTransportAdapter.ThrottleMode x$1)

throttledMessages

public scala.collection.immutable.Queue<ByteString> throttledMessages()

throttledMessages_$eq

public void throttledMessages_$eq(scala.collection.immutable.Queue<ByteString> x$1)

upstreamListener

public AssociationHandle.HandleEventListener upstreamListener()

upstreamListener_$eq

public void upstreamListener_$eq(AssociationHandle.HandleEventListener x$1)

postStop

public void postStop()

Description copied from interface: Actor

User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

Specified by:

postStop in interface Actor

Specified by:

postStop in interface FSM<ThrottledAssociation.ThrottlerState,ThrottledAssociation.ThrottlerData>

forwardOrDelay

public void forwardOrDelay(ByteString payload)

scheduleDequeue

public void scheduleDequeue(scala.concurrent.duration.FiniteDuration delay)