akka.cluster.sharding

Class ClusterSharding

java.lang.Object

akka.cluster.sharding.ClusterSharding

All Implemented Interfaces:

Extension

public class ClusterSharding
extends java.lang.Object
implements Extension

See Also:

ClusterSharding companion object

Constructor Summary

Constructors

Constructor and Description
ClusterSharding(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method and Description
static ClusterSharding	createExtension(ExtendedActorSystem system)
static ClusterSharding	get(ActorSystem system)
static ClusterSharding$	lookup()
void	requireClusterRole(scala.Option<java.lang.String> role)
ActorRef	shardRegion(java.lang.String typeName) Retrieve the actor reference of the ShardRegion actor responsible for the named entity type.
ActorRef	start(java.lang.String typeName, Props entityProps, ClusterShardingSettings settings, scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId, scala.Function1<java.lang.Object,java.lang.String> extractShardId) Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages.
ActorRef	start(java.lang.String typeName, Props entityProps, ClusterShardingSettings settings, scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId, scala.Function1<java.lang.Object,java.lang.String> extractShardId, ShardCoordinator.ShardAllocationStrategy allocationStrategy, java.lang.Object handOffStopMessage) Scala API: Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages.
ActorRef	start(java.lang.String typeName, Props entityProps, ClusterShardingSettings settings, ShardRegion.MessageExtractor messageExtractor) Java/Scala API: Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages.
ActorRef	start(java.lang.String typeName, Props entityProps, ClusterShardingSettings settings, ShardRegion.MessageExtractor messageExtractor, ShardCoordinator.ShardAllocationStrategy allocationStrategy, java.lang.Object handOffStopMessage) Java/Scala API: Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages.
ActorRef	startProxy(java.lang.String typeName, scala.Option<java.lang.String> role, scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId, scala.Function1<java.lang.Object,java.lang.String> extractShardId) Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e.
ActorRef	startProxy(java.lang.String typeName, java.util.Optional<java.lang.String> role, ShardRegion.MessageExtractor messageExtractor) Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterSharding

public ClusterSharding(ExtendedActorSystem system)

Method Detail

get

public static ClusterSharding get(ActorSystem system)

lookup

public static ClusterSharding$ lookup()

createExtension

public static ClusterSharding createExtension(ExtendedActorSystem system)

requireClusterRole

public void requireClusterRole(scala.Option<java.lang.String> role)

start

public ActorRef start(java.lang.String typeName,
                      Props entityProps,
                      ClusterShardingSettings settings,
                      scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId,
                      scala.Function1<java.lang.Object,java.lang.String> extractShardId,
                      ShardCoordinator.ShardAllocationStrategy allocationStrategy,
                      java.lang.Object handOffStopMessage)

Scala API: Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion(java.lang.String) method.

Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

Parameters:

typeName - the name of the entity type

entityProps - the Props of the entity actors that will be created by the ShardRegion

settings - configuration settings, see ClusterShardingSettings

extractEntityId - partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

extractShardId - function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

allocationStrategy - possibility to use a custom shard allocation and rebalancing logic

handOffStopMessage - the message that will be sent to entities when they are to be stopped for a rebalance or graceful shutdown of a ShardRegion, e.g. PoisonPill.

Returns:

the actor ref of the ShardRegion that is to be responsible for the shard

start

public ActorRef start(java.lang.String typeName,
                      Props entityProps,
                      ClusterShardingSettings settings,
                      scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId,
                      scala.Function1<java.lang.Object,java.lang.String> extractShardId)

Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion(java.lang.String) method.

The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy is used. PoisonPill is used as handOffStopMessage.

Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

Parameters:

typeName - the name of the entity type

entityProps - the Props of the entity actors that will be created by the ShardRegion

settings - configuration settings, see ClusterShardingSettings

extractEntityId - partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

extractShardId - function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

Returns:

the actor ref of the ShardRegion that is to be responsible for the shard

start

public ActorRef start(java.lang.String typeName,
                      Props entityProps,
                      ClusterShardingSettings settings,
                      ShardRegion.MessageExtractor messageExtractor,
                      ShardCoordinator.ShardAllocationStrategy allocationStrategy,
                      java.lang.Object handOffStopMessage)

Java/Scala API: Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion(java.lang.String) method.

Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

Parameters:

typeName - the name of the entity type

entityProps - the Props of the entity actors that will be created by the ShardRegion

settings - configuration settings, see ClusterShardingSettings

messageExtractor - functions to extract the entity id, shard id, and the message to send to the entity from the incoming message, see ShardRegion.MessageExtractor

allocationStrategy - possibility to use a custom shard allocation and rebalancing logic

handOffStopMessage - the message that will be sent to entities when they are to be stopped for a rebalance or graceful shutdown of a ShardRegion, e.g. PoisonPill.

Returns:

the actor ref of the ShardRegion that is to be responsible for the shard

start

public ActorRef start(java.lang.String typeName,
                      Props entityProps,
                      ClusterShardingSettings settings,
                      ShardRegion.MessageExtractor messageExtractor)

Java/Scala API: Register a named entity type by defining the Props of the entity actor and functions to extract entity and shard identifier from messages. The ShardRegion actor for this type can later be retrieved with the shardRegion(java.lang.String) method.

The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy is used. PoisonPill is used as handOffStopMessage.

Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

Parameters:

typeName - the name of the entity type

entityProps - the Props of the entity actors that will be created by the ShardRegion

settings - configuration settings, see ClusterShardingSettings

messageExtractor - functions to extract the entity id, shard id, and the message to send to the entity from the incoming message

Returns:

the actor ref of the ShardRegion that is to be responsible for the shard

startProxy

public ActorRef startProxy(java.lang.String typeName,
                           scala.Option<java.lang.String> role,
                           scala.PartialFunction<java.lang.Object,scala.Tuple2<java.lang.String,java.lang.Object>> extractEntityId,
                           scala.Function1<java.lang.Object,java.lang.String> extractShardId)

Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entity actors itself. The ShardRegion actor for this type can later be retrieved with the shardRegion(java.lang.String) method.

Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

Parameters:

typeName - the name of the entity type

role - specifies that this entity type is located on cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

extractEntityId - partial function to extract the entity id and the message to send to the entity from the incoming message, if the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream

extractShardId - function to determine the shard id for an incoming message, only messages that passed the extractEntityId will be used

Returns:

the actor ref of the ShardRegion that is to be responsible for the shard

startProxy

public ActorRef startProxy(java.lang.String typeName,
                           java.util.Optional<java.lang.String> role,
                           ShardRegion.MessageExtractor messageExtractor)

Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode, i.e. it will delegate messages to other ShardRegion actors on other nodes, but not host any entity actors itself. The ShardRegion actor for this type can later be retrieved with the shardRegion(java.lang.String) method.

Some settings can be configured as described in the akka.cluster.sharding section of the reference.conf.

Parameters:

typeName - the name of the entity type

role - specifies that this entity type is located on cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

messageExtractor - functions to extract the entity id, shard id, and the message to send to the entity from the incoming message

Returns:

the actor ref of the ShardRegion that is to be responsible for the shard

shardRegion

public ActorRef shardRegion(java.lang.String typeName)

Retrieve the actor reference of the ShardRegion actor responsible for the named entity type. The entity type must be registered with the start(java.lang.String, akka.actor.Props, akka.cluster.sharding.ClusterShardingSettings, scala.PartialFunction<java.lang.Object, scala.Tuple2<java.lang.String, java.lang.Object>>, scala.Function1<java.lang.Object, java.lang.String>, akka.cluster.sharding.ShardCoordinator.ShardAllocationStrategy, java.lang.Object) method before it can be used here. Messages to the entity is always sent via the ShardRegion.

Parameters:

typeName - (undocumented)

Returns:

(undocumented)