akka.cluster

Class ClusterRemoteWatcher

java.lang.Object

akka.remote.RemoteWatcher

akka.cluster.ClusterRemoteWatcher

All Implemented Interfaces:

Actor, ActorLogging, RequiresMessageQueue<UnboundedMessageQueueSemantics>

public class ClusterRemoteWatcher
extends RemoteWatcher

INTERNAL API

Specialization of RemoteWatcher that keeps track of cluster member nodes and is responsible for watchees on cluster nodes. AddressTerminated is published when node is removed from cluster.

RemoteWatcher handles non-cluster nodes. ClusterRemoteWatcher will take over responsibility from RemoteWatcher if a watch is added before a node is member of the cluster and then later becomes cluster member.

Nested Class Summary

Nested classes/interfaces inherited from class akka.remote.RemoteWatcher

RemoteWatcher.ArteryHeartbeat$, RemoteWatcher.ArteryHeartbeatRsp, RemoteWatcher.ArteryHeartbeatRsp$, RemoteWatcher.ExpectedFirstHeartbeat, RemoteWatcher.ExpectedFirstHeartbeat$, RemoteWatcher.Heartbeat$, RemoteWatcher.HeartbeatRsp, RemoteWatcher.HeartbeatRsp$, RemoteWatcher.HeartbeatTick$, RemoteWatcher.ReapUnreachableTick$, RemoteWatcher.Stats, RemoteWatcher.Stats$, RemoteWatcher.UnwatchRemote, RemoteWatcher.UnwatchRemote$, RemoteWatcher.WatchRemote, RemoteWatcher.WatchRemote$

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

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
ClusterRemoteWatcher(FailureDetectorRegistry<Address> failureDetector, scala.concurrent.duration.FiniteDuration heartbeatInterval, scala.concurrent.duration.FiniteDuration unreachableReaperInterval, scala.concurrent.duration.FiniteDuration heartbeatExpectedResponseAfter)

Method Summary

Modifier and Type	Method and Description
static void	addressUids_$eq(scala.collection.immutable.Map<Address,java.lang.Object> x$1)
static scala.collection.immutable.Map<Address,java.lang.Object>	addressUids()
static void	addWatch(InternalActorRef watchee, InternalActorRef watcher)
protected static void	akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)
protected static void	akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)
static void	akka$actor$ActorLogging$$_log_$eq(LoggingAdapter x$1)
static LoggingAdapter	akka$actor$ActorLogging$$_log()
protected static void	aroundPostRestart(java.lang.Throwable reason)
protected static void	aroundPostStop()
protected static void	aroundPreRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message)
protected static void	aroundPreStart()
protected static void	aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive, java.lang.Object msg)
static boolean	artery()
Cluster	cluster()
scala.collection.immutable.Set<Address>	clusterNodes()
static ActorContext	context()
void	delayedQuarantine(Member m, MemberStatus previousStatus)
static Cancellable	failureDetectorReaperTask()
static HeartbeatMessage	heartBeatMsg()
static Cancellable	heartbeatTask()
static LoggingAdapter	log()
void	memberRemoved(Member m, MemberStatus previousStatus)
void	memberUp(Member m)
static void	postRestart(java.lang.Throwable reason)
void	postStop() User overridable callback.
static void	preRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message)
void	preStart() User overridable callback.
static Props	props(FailureDetectorRegistry<Address> failureDetector, scala.concurrent.duration.FiniteDuration heartbeatInterval, scala.concurrent.duration.FiniteDuration unreachableReaperInterval, scala.concurrent.duration.FiniteDuration heartbeatExpectedResponseAfter) Factory method for ClusterRemoteWatcher Props.
static void	publishAddressTerminated(Address address)
static void	quarantine(Address address, scala.Option<java.lang.Object> uid, java.lang.String reason)
static void	reapUnreachable()
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receive() This defines the initial actor behavior, it must return a partial function with the actor logic.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receiveClusterEvent()
static void	receiveHeartbeat()
static void	receiveHeartbeatRsp(long uid)
static RemoteActorRefProvider	remoteProvider()
static void	removeWatch(InternalActorRef watchee, InternalActorRef watcher)
static void	removeWatchee(InternalActorRef watchee)
static void	reWatch(Address address)
static Scheduler	scheduler()
static ActorRef	self()
static HeartbeatMessage	selfHeartbeatRspMsg()
static ActorRef	sender()
static void	sendHeartbeat()
static SupervisorStrategy	supervisorStrategy()
void	takeOverResponsibility(Address address) When a cluster node is added this class takes over the responsibility for watchees on that node already handled by super RemoteWatcher.
static void	terminated(InternalActorRef watchee, boolean existenceConfirmed, boolean addressTerminated)
static void	triggerFirstHeartbeat(Address address)
static void	unhandled(java.lang.Object message)
static void	unreachable_$eq(scala.collection.immutable.Set<Address> x$1)
static scala.collection.immutable.Set<Address>	unreachable()
static void	unwatchNode(Address watcheeAddress)
static scala.collection.mutable.HashMap<Address,scala.collection.mutable.Set<InternalActorRef>>	watcheeByNodes()
static scala.collection.mutable.HashMap<InternalActorRef,scala.collection.mutable.Set<InternalActorRef>>	watching()
static scala.collection.Set<Address>	watchingNodes()
void	watchNode(InternalActorRef watchee)

Methods inherited from class akka.remote.RemoteWatcher

addressUids, addWatch, artery, context, failureDetectorReaperTask, heartBeatMsg, heartbeatTask, publishAddressTerminated, quarantine, reapUnreachable, receiveHeartbeat, receiveHeartbeatRsp, remoteProvider, removeWatch, removeWatchee, reWatch, scheduler, self, selfHeartbeatRspMsg, sendHeartbeat, terminated, triggerFirstHeartbeat, unreachable, unwatchNode, watcheeByNodes, watching, watchingNodes

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, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

ClusterRemoteWatcher

public ClusterRemoteWatcher(FailureDetectorRegistry<Address> failureDetector,
                            scala.concurrent.duration.FiniteDuration heartbeatInterval,
                            scala.concurrent.duration.FiniteDuration unreachableReaperInterval,
                            scala.concurrent.duration.FiniteDuration heartbeatExpectedResponseAfter)

Method Detail

props

public static Props props(FailureDetectorRegistry<Address> failureDetector,
                          scala.concurrent.duration.FiniteDuration heartbeatInterval,
                          scala.concurrent.duration.FiniteDuration unreachableReaperInterval,
                          scala.concurrent.duration.FiniteDuration heartbeatExpectedResponseAfter)

Factory method for ClusterRemoteWatcher Props.

Parameters:

failureDetector - (undocumented)

heartbeatInterval - (undocumented)

unreachableReaperInterval - (undocumented)

heartbeatExpectedResponseAfter - (undocumented)

Returns:

(undocumented)

sender

public static final ActorRef sender()

aroundReceive

protected static void aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive,
                                    java.lang.Object msg)

aroundPreStart

protected static void aroundPreStart()

aroundPostStop

protected static void aroundPostStop()

aroundPreRestart

protected static void aroundPreRestart(java.lang.Throwable reason,
                                       scala.Option<java.lang.Object> message)

aroundPostRestart

protected static void aroundPostRestart(java.lang.Throwable reason)

supervisorStrategy

public static SupervisorStrategy supervisorStrategy()

preRestart

public static void preRestart(java.lang.Throwable reason,
                              scala.Option<java.lang.Object> message)
                       throws java.lang.Exception

Throws:

java.lang.Exception

postRestart

public static void postRestart(java.lang.Throwable reason)
                        throws java.lang.Exception

Throws:

java.lang.Exception

unhandled

public static void unhandled(java.lang.Object message)

log

public static LoggingAdapter log()

scheduler

public static Scheduler scheduler()

remoteProvider

public static RemoteActorRefProvider remoteProvider()

artery

public static boolean artery()

heartBeatMsg

public static HeartbeatMessage heartBeatMsg()

selfHeartbeatRspMsg

public static HeartbeatMessage selfHeartbeatRspMsg()

watching

public static scala.collection.mutable.HashMap<InternalActorRef,scala.collection.mutable.Set<InternalActorRef>> watching()

watcheeByNodes

public static scala.collection.mutable.HashMap<Address,scala.collection.mutable.Set<InternalActorRef>> watcheeByNodes()

watchingNodes

public static scala.collection.Set<Address> watchingNodes()

unreachable

public static scala.collection.immutable.Set<Address> unreachable()

unreachable_$eq

public static void unreachable_$eq(scala.collection.immutable.Set<Address> x$1)

addressUids

public static scala.collection.immutable.Map<Address,java.lang.Object> addressUids()

addressUids_$eq

public static void addressUids_$eq(scala.collection.immutable.Map<Address,java.lang.Object> x$1)

heartbeatTask

public static Cancellable heartbeatTask()

failureDetectorReaperTask

public static Cancellable failureDetectorReaperTask()

receiveHeartbeat

public static void receiveHeartbeat()

receiveHeartbeatRsp

public static void receiveHeartbeatRsp(long uid)

reapUnreachable

public static void reapUnreachable()

publishAddressTerminated

public static void publishAddressTerminated(Address address)

quarantine

public static void quarantine(Address address,
                              scala.Option<java.lang.Object> uid,
                              java.lang.String reason)

addWatch

public static void addWatch(InternalActorRef watchee,
                            InternalActorRef watcher)

removeWatch

public static void removeWatch(InternalActorRef watchee,
                               InternalActorRef watcher)

removeWatchee

public static void removeWatchee(InternalActorRef watchee)

unwatchNode

public static void unwatchNode(Address watcheeAddress)

terminated

public static void terminated(InternalActorRef watchee,
                              boolean existenceConfirmed,
                              boolean addressTerminated)

sendHeartbeat

public static void sendHeartbeat()

triggerFirstHeartbeat

public static void triggerFirstHeartbeat(Address address)

reWatch

public static void reWatch(Address address)

akka$actor$ActorLogging$$_log

public static LoggingAdapter akka$actor$ActorLogging$$_log()

akka$actor$ActorLogging$$_log_$eq

public static void akka$actor$ActorLogging$$_log_$eq(LoggingAdapter x$1)

context

public static ActorContext context()

self

public static final ActorRef self()

akka$actor$Actor$_setter_$context_$eq

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

akka$actor$Actor$_setter_$self_$eq

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

cluster

public Cluster cluster()

clusterNodes

public scala.collection.immutable.Set<Address> clusterNodes()

preStart

public void preStart()

Description copied from interface: Actor

User overridable callback.

Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

Specified by:

preStart in interface Actor

Overrides:

preStart in class RemoteWatcher

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

Overrides:

postStop in class RemoteWatcher

receive

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()

Description copied from interface: Actor

This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:

receive in interface Actor

Overrides:

receive in class RemoteWatcher

Returns:

(undocumented)

receiveClusterEvent

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receiveClusterEvent()

memberUp

public void memberUp(Member m)

memberRemoved

public void memberRemoved(Member m,
                          MemberStatus previousStatus)

delayedQuarantine

public void delayedQuarantine(Member m,
                              MemberStatus previousStatus)

watchNode

public void watchNode(InternalActorRef watchee)

Overrides:

watchNode in class RemoteWatcher

takeOverResponsibility

public void takeOverResponsibility(Address address)

When a cluster node is added this class takes over the responsibility for watchees on that node already handled by super RemoteWatcher.

Parameters:

address - (undocumented)