akka.cluster.sharding

Class ShardCoordinator

java.lang.Object

akka.cluster.sharding.ShardCoordinator

All Implemented Interfaces:

Actor, ActorLogging

Direct Known Subclasses:

DDataShardCoordinator, PersistentShardCoordinator

public abstract class ShardCoordinator
extends java.lang.Object
implements Actor, ActorLogging

Singleton coordinator that decides where to allocate shards.

See Also:

ClusterSharding extension

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShardCoordinator.AbstractShardAllocationStrategy Java API: Java implementations of custom shard allocation and rebalancing logic used by the ShardCoordinator should extend this abstract class and implement the two methods.
static class	ShardCoordinator.Internal$ INTERNAL API
static class	ShardCoordinator.LeastShardAllocationStrategy The default implementation of ShardCoordinator.LeastShardAllocationStrategy allocates new shards to the ShardRegion with least number of previously allocated shards.
static class	ShardCoordinator.RebalanceWorker INTERNAL API.
static interface	ShardCoordinator.ShardAllocationStrategy Interface of the pluggable shard allocation and rebalancing logic used by the ShardCoordinator.

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

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
ShardCoordinator(java.lang.String typeName, ClusterShardingSettings settings, akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy allocationStrategy)

Method Summary

Modifier and Type	Method and Description
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	active()
protected abstract static void	akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)
protected abstract 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()
scala.collection.immutable.Set<ActorRef>	aliveRegions()
void	allocateShardHomesForRememberEntities()
boolean	allRegionsRegistered()
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)
Cluster	cluster()
ActorContext	context() Stores the context for this actor, including self, and sender.
void	continueGetShardHome(java.lang.String shard, ActorRef region, ActorRef getShardHomeSender)
void	continueRebalance(scala.collection.immutable.Set<java.lang.String> shards)
scala.collection.immutable.Set<ActorRef>	gracefulShutdownInProgress()
boolean	hasAllRegionsRegistered()
boolean	isMember(ActorRef region)
static LoggingAdapter	log()
int	minMembers()
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)
static void	preStart()
static Props	props(java.lang.String typeName, ClusterShardingSettings settings, akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy allocationStrategy) INTERNAL API Factory method for the Props of the ShardCoordinator actor.
static Props	props(java.lang.String typeName, ClusterShardingSettings settings, akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy allocationStrategy, ActorRef replicator) INTERNAL API Factory method for the Props of the ShardCoordinator actor with state based on ddata.
scala.collection.immutable.Set<java.lang.String>	rebalanceInProgress()
Cancellable	rebalanceTask()
static Props	rebalanceWorkerProps(java.lang.String shard, ActorRef from, scala.concurrent.duration.FiniteDuration handOffTimeout, scala.collection.immutable.Set<ActorRef> regions)
abstract static scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receive()
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receiveTerminated()
void	regionProxyTerminated(ActorRef ref)
void	regionTerminated(ActorRef ref)
scala.collection.immutable.Set<ActorRef>	regionTerminationInProgress()
scala.concurrent.duration.FiniteDuration	removalMargin()
ActorRef	self() The 'self' field holds the ActorRef for this actor.
static ActorRef	sender()
void	sendHostShardMsg(java.lang.String shard, ActorRef region)
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	shuttingDown()
akka.cluster.sharding.ShardCoordinator.Internal.State	state()
void	stateInitialized()
static SupervisorStrategy	supervisorStrategy()
scala.collection.immutable.Map<java.lang.String,Cancellable>	unAckedHostShards()
static void	unhandled(java.lang.Object message)
abstract <E extends akka.cluster.sharding.ShardCoordinator.Internal.DomainEvent> void	update(E evt, scala.Function1<E,scala.runtime.BoxedUnit> f)
void	watchStateActors()

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

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

ShardCoordinator

public ShardCoordinator(java.lang.String typeName,
                        ClusterShardingSettings settings,
                        akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy allocationStrategy)

Method Detail

props

public static Props props(java.lang.String typeName,
                          ClusterShardingSettings settings,
                          akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy allocationStrategy)

INTERNAL API Factory method for the Props of the ShardCoordinator actor.

Parameters:

typeName - (undocumented)

settings - (undocumented)

allocationStrategy - (undocumented)

Returns:

(undocumented)

props

public static Props props(java.lang.String typeName,
                          ClusterShardingSettings settings,
                          akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy allocationStrategy,
                          ActorRef replicator)

INTERNAL API Factory method for the Props of the ShardCoordinator actor with state based on ddata.

Parameters:

typeName - (undocumented)

settings - (undocumented)

allocationStrategy - (undocumented)

replicator - (undocumented)

Returns:

(undocumented)

rebalanceWorkerProps

public static Props rebalanceWorkerProps(java.lang.String shard,
                                         ActorRef from,
                                         scala.concurrent.duration.FiniteDuration handOffTimeout,
                                         scala.collection.immutable.Set<ActorRef> regions)

sender

public static final ActorRef sender()

receive

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

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()

preStart

public static void preStart()
                     throws java.lang.Exception

Throws:

java.lang.Exception

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)

akka$actor$Actor$_setter_$context_$eq

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

akka$actor$Actor$_setter_$self_$eq

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

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)

log

public static LoggingAdapter log()

context

public ActorContext context()

Description copied from interface: Actor

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 UntypedActorContext, 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)

cluster

public Cluster cluster()

removalMargin

public scala.concurrent.duration.FiniteDuration removalMargin()

minMembers

public int minMembers()

allRegionsRegistered

public boolean allRegionsRegistered()

state

public akka.cluster.sharding.ShardCoordinator.Internal.State state()

rebalanceInProgress

public scala.collection.immutable.Set<java.lang.String> rebalanceInProgress()

unAckedHostShards

public scala.collection.immutable.Map<java.lang.String,Cancellable> unAckedHostShards()

gracefulShutdownInProgress

public scala.collection.immutable.Set<ActorRef> gracefulShutdownInProgress()

aliveRegions

public scala.collection.immutable.Set<ActorRef> aliveRegions()

regionTerminationInProgress

public scala.collection.immutable.Set<ActorRef> regionTerminationInProgress()

rebalanceTask

public Cancellable rebalanceTask()

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

isMember

public boolean isMember(ActorRef region)

active

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

receiveTerminated

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

update

public abstract <E extends akka.cluster.sharding.ShardCoordinator.Internal.DomainEvent> void update(E evt,
                                                                                                    scala.Function1<E,scala.runtime.BoxedUnit> f)

watchStateActors

public void watchStateActors()

stateInitialized

public void stateInitialized()

hasAllRegionsRegistered

public boolean hasAllRegionsRegistered()

regionTerminated

public void regionTerminated(ActorRef ref)

regionProxyTerminated

public void regionProxyTerminated(ActorRef ref)

shuttingDown

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

sendHostShardMsg

public void sendHostShardMsg(java.lang.String shard,
                             ActorRef region)

allocateShardHomesForRememberEntities

public void allocateShardHomesForRememberEntities()

continueGetShardHome

public void continueGetShardHome(java.lang.String shard,
                                 ActorRef region,
                                 ActorRef getShardHomeSender)

continueRebalance

public void continueRebalance(scala.collection.immutable.Set<java.lang.String> shards)