Package akka.remote.transport

Class ProtocolStateActor

java.lang.Object

akka.remote.transport.ProtocolStateActor

All Implemented Interfaces:

Actor, ActorLogging, FSM<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>, RequiresMessageQueue<UnboundedMessageQueueSemantics>, Listeners

public class ProtocolStateActor
extends java.lang.Object
implements Actor, FSM<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>, RequiresMessageQueue<UnboundedMessageQueueSemantics>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProtocolStateActor.AssociatedWaitHandler
static class	ProtocolStateActor.AssociatedWaitHandler$
static interface	ProtocolStateActor.AssociationState
static class	ProtocolStateActor.Closed$
static class	ProtocolStateActor.ForbiddenUidReason$
static class	ProtocolStateActor.Handle
static class	ProtocolStateActor.Handle$
static class	ProtocolStateActor.HandleListenerRegistered
static class	ProtocolStateActor.HandleListenerRegistered$
static class	ProtocolStateActor.HandshakeTimer$
static class	ProtocolStateActor.HeartbeatTimer$
static class	ProtocolStateActor.InboundUnassociated
static class	ProtocolStateActor.InboundUnassociated$
static interface	ProtocolStateActor.InitialProtocolStateData
static class	ProtocolStateActor.ListenerReady
static class	ProtocolStateActor.ListenerReady$
static class	ProtocolStateActor.Open$
static class	ProtocolStateActor.OutboundUnassociated
static class	ProtocolStateActor.OutboundUnassociated$
static class	ProtocolStateActor.OutboundUnderlyingAssociated
static class	ProtocolStateActor.OutboundUnderlyingAssociated$
static interface	ProtocolStateActor.ProtocolStateData
static class	ProtocolStateActor.TimeoutReason
static class	ProtocolStateActor.TimeoutReason$
static class	ProtocolStateActor.WaitHandshake$

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<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
ProtocolStateActor(HandshakeInfo handshakeInfo, Address remoteAddress, scala.concurrent.Promise<AssociationHandle> statusPromise, Transport transport, AkkaProtocolSettings settings, AkkaPduCodec codec, FailureDetector failureDetector, scala.Option<java.lang.Object> refuseUid)
ProtocolStateActor(HandshakeInfo handshakeInfo, AssociationHandle wrappedHandle, Transport.AssociationEventListener associationListener, AkkaProtocolSettings settings, AkkaPduCodec codec, FailureDetector failureDetector)
ProtocolStateActor(ProtocolStateActor.InitialProtocolStateData initialData, HandshakeInfo localHandshakeInfo, scala.Option<java.lang.Object> refuseUid, AkkaProtocolSettings settings, AkkaPduCodec codec, FailureDetector failureDetector)

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)
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$routing$Listeners$_setter_$listeners_$eq(java.util.Set<ActorRef> x$1)
ActorContext	context()	Scala API: Stores the context for this actor, including self, and sender.
FSM.Event$	Event()
java.lang.String	handshakeTimerKey()
static Props	inboundProps(HandshakeInfo handshakeInfo, AssociationHandle wrappedHandle, Transport.AssociationEventListener associationListener, AkkaProtocolSettings settings, AkkaPduCodec codec, FailureDetector failureDetector)
protected java.util.Set<ActorRef>	listeners()
Address	localAddress()
protected void	logTermination(FSM.Reason reason)	By default FSM.Failure is logged at error level and other reason types are not logged.
static Props	outboundProps(HandshakeInfo handshakeInfo, Address remoteAddress, scala.concurrent.Promise<AssociationHandle> statusPromise, Transport transport, AkkaProtocolSettings settings, AkkaPduCodec codec, FailureDetector failureDetector, scala.Option<java.lang.Object> refuseUid)
void	postStop()	User overridable callback.
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()

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, makeTransition, nextState_$eq, nextStateData, onTermination, onTransition, 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

ProtocolStateActor

public ProtocolStateActor(ProtocolStateActor.InitialProtocolStateData initialData,
                          HandshakeInfo localHandshakeInfo,
                          scala.Option<java.lang.Object> refuseUid,
                          AkkaProtocolSettings settings,
                          AkkaPduCodec codec,
                          FailureDetector failureDetector)

ProtocolStateActor

public ProtocolStateActor(HandshakeInfo handshakeInfo,
                          Address remoteAddress,
                          scala.concurrent.Promise<AssociationHandle> statusPromise,
                          Transport transport,
                          AkkaProtocolSettings settings,
                          AkkaPduCodec codec,
                          FailureDetector failureDetector,
                          scala.Option<java.lang.Object> refuseUid)

ProtocolStateActor

public ProtocolStateActor(HandshakeInfo handshakeInfo,
                          AssociationHandle wrappedHandle,
                          Transport.AssociationEventListener associationListener,
                          AkkaProtocolSettings settings,
                          AkkaPduCodec codec,
                          FailureDetector failureDetector)

Method Detail

outboundProps

public static Props outboundProps(HandshakeInfo handshakeInfo,
                                  Address remoteAddress,
                                  scala.concurrent.Promise<AssociationHandle> statusPromise,
                                  Transport transport,
                                  AkkaProtocolSettings settings,
                                  AkkaPduCodec codec,
                                  FailureDetector failureDetector,
                                  scala.Option<java.lang.Object> refuseUid)

inboundProps

public static Props inboundProps(HandshakeInfo handshakeInfo,
                                 AssociationHandle wrappedHandle,
                                 Transport.AssociationEventListener associationListener,
                                 AkkaProtocolSettings settings,
                                 AkkaPduCodec codec,
                                 FailureDetector failureDetector)

Event

public FSM.Event$ Event()

Specified by:

Event in interface FSM<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

StopEvent

public FSM.StopEvent$ StopEvent()

Specified by:

StopEvent in interface FSM<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

$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<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

Returns:

(undocumented)

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<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

Returns:

(undocumented)

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<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

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<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

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<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

Parameters:

x$1 - (undocumented)

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

Returns:

(undocumented)

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

Returns:

(undocumented)

akka$actor$Actor$_setter_$context_$eq

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

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

Parameters:

x$1 - (undocumented)

localAddress

public Address localAddress()

handshakeTimerKey

public java.lang.String handshakeTimerKey()

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<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

logTermination

protected void logTermination(FSM.Reason reason)

Description copied from interface: FSM

By default FSM.Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.

Specified by:

logTermination in interface FSM<ProtocolStateActor.AssociationState,ProtocolStateActor.ProtocolStateData>

Parameters:

reason - (undocumented)