Package akka.cluster

Class ClusterActorRefProvider

java.lang.Object

akka.remote.RemoteActorRefProvider

akka.cluster.ClusterActorRefProvider

All Implemented Interfaces:

ActorRefProvider

public class ClusterActorRefProvider
extends RemoteActorRefProvider

INTERNAL API

The ClusterActorRefProvider will load the Cluster extension, i.e. the cluster will automatically be started when the ClusterActorRefProvider is used.

Nested Class Summary

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

RemoteActorRefProvider.Finished$, RemoteActorRefProvider.Idle$, RemoteActorRefProvider.TerminatorState, RemoteActorRefProvider.Uninitialized$, RemoteActorRefProvider.WaitDaemonShutdown$, RemoteActorRefProvider.WaitTransportShutdown$

Constructor Summary

Constructors

Constructor	Description
ClusterActorRefProvider(java.lang.String _systemName, ActorSystem.Settings _settings, EventStream _eventStream, DynamicAccess _dynamicAccess)

Method Summary

Modifier and Type	Method	Description
protected ClusterDeployer	createDeployer()	Factory method to make it possible to override deployer in subclass Creates a new instance every time
protected ActorRef	createRemoteWatcher(ActorSystemImpl system)
void	init(ActorSystemImpl system)	INTERNAL API: Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc.
protected boolean	shouldCreateRemoteActorRef(ActorSystem system, Address address)	Override to add any additional checks if using `RemoteActorRefProvider` as a superclass.
protected void	warnIfDirectUse()	Can be overridden when using RemoteActorRefProvider as a superclass rather than directly
protected void	warnIfNotRemoteActorRef(ActorPath path)	If warnOnUnsafeRemote, this logs a warning if actorOf falls back to LocalActorRef versus creating a RemoteActorRef.

Methods inherited from class akka.remote.RemoteActorRefProvider

actorOf, addressString, createRemoteDeploymentWatcher, createRemoteWatcherFailureDetector, deadLetters, deployer, dynamicAccess, eventStream, getDefaultAddress, getExternalAddressFor, guardian, hasClusterOrUseUnsafe, ignoreRef, internalResolveActorRef, local, log, quarantine, registerTempActor, remoteDaemon, remoteSettings, remoteWatcher, resolveActorRef, resolveActorRef, resolveActorRefWithLocalAddress, rootGuardian, rootGuardianAt, rootPath, serializationInformation, settings, systemGuardian, systemName, tempContainer, tempPath, tempPath, terminationFuture, transport, unregisterTempActor, useActorOnNode, warnIfUnsafeDeathwatchWithoutCluster, warnIfUseUnsafeWithoutCluster, warnOnUnsafe

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterActorRefProvider

public ClusterActorRefProvider(java.lang.String _systemName,
                               ActorSystem.Settings _settings,
                               EventStream _eventStream,
                               DynamicAccess _dynamicAccess)

Method Detail

createDeployer

protected ClusterDeployer createDeployer()

Factory method to make it possible to override deployer in subclass Creates a new instance every time

Overrides:

createDeployer in class RemoteActorRefProvider

createRemoteWatcher

protected ActorRef createRemoteWatcher(ActorSystemImpl system)

Overrides:

createRemoteWatcher in class RemoteActorRefProvider

init

public void init(ActorSystemImpl system)

Description copied from interface: ActorRefProvider

INTERNAL API: Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc. and then—when the ActorSystem is constructed—the second phase during which actors may be created (e.g. the guardians).

Specified by:

init in interface ActorRefProvider

Overrides:

init in class RemoteActorRefProvider

shouldCreateRemoteActorRef

protected boolean shouldCreateRemoteActorRef(ActorSystem system,
                                             Address address)

Description copied from class: RemoteActorRefProvider

Override to add any additional checks if using `RemoteActorRefProvider` as a superclass.

Overrides:

shouldCreateRemoteActorRef in class RemoteActorRefProvider

warnIfDirectUse

protected void warnIfDirectUse()

Description copied from class: RemoteActorRefProvider

Can be overridden when using RemoteActorRefProvider as a superclass rather than directly

Overrides:

warnIfDirectUse in class RemoteActorRefProvider

warnIfNotRemoteActorRef

protected void warnIfNotRemoteActorRef(ActorPath path)

Description copied from class: RemoteActorRefProvider

If warnOnUnsafeRemote, this logs a warning if actorOf falls back to LocalActorRef versus creating a RemoteActorRef. Override to log a more granular reason if using RemoteActorRefProvider as a superclass.

Overrides:

warnIfNotRemoteActorRef in class RemoteActorRefProvider