ClusterSharding
Related Docs:
object ClusterSharding
| package sharding
Java API: get all currently defined sharding type names.
Retrieve the actor reference of the ShardRegion actor responsible for the named entity type.
Retrieve the actor reference of the ShardRegion actor responsible for the named entity type.
The entity type must be registered with the #start or #startProxy method before it
can be used here. Messages to the entity is always sent via the ShardRegion.
Retrieve the actor reference of the ShardRegion actor that will act as a proxy to the named entity type running in another data center.
Retrieve the actor reference of the ShardRegion actor that will act as a proxy to the
named entity type running in another data center. A proxy within the same data center can be accessed
with #shardRegion instead of this method. The entity type must be registered with the
#startProxy method before it can be used here. Messages to the entity is always sent
via the ShardRegion.
Scala API: get all currently defined sharding type names.
Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.
Java/Scala API: Register a named entity type by defining the akka.actor.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 method.
The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy
is used. akka.actor.PoisonPill is used as handOffStopMessage.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
the Props of the entity actors that will be created by the ShardRegion
configuration settings, see ClusterShardingSettings
functions to extract the entity id, shard id, and the message to send to the entity from the incoming message
the actor ref of the ShardRegion that is to be responsible for the shard
Java/Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.
Java/Scala API: Register a named entity type by defining the akka.actor.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 method.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
the Props of the entity actors that will be created by the ShardRegion
configuration settings, see ClusterShardingSettings
functions to extract the entity id, shard id, and the message to send to the entity from the incoming message, see ShardRegion.MessageExtractor
possibility to use a custom shard allocation and rebalancing logic
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.
the actor ref of the ShardRegion that is to be responsible for the shard
Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.
Register a named entity type by defining the akka.actor.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 method.
The default shard allocation strategy ShardCoordinator.LeastShardAllocationStrategy
is used. akka.actor.PoisonPill is used as handOffStopMessage.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
the Props of the entity actors that will be created by the ShardRegion
configuration settings, see ClusterShardingSettings
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
function to determine the shard id for an incoming message, only messages
that passed the extractEntityId will be used
the actor ref of the ShardRegion that is to be responsible for the shard
Scala API: Register a named entity type by defining the akka.actor.Props of the entity actor and functions to extract entity and shard identifier from messages.
Scala API: Register a named entity type by defining the akka.actor.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 method.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
the Props of the entity actors that will be created by the ShardRegion
configuration settings, see ClusterShardingSettings
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
function to determine the shard id for an incoming message, only messages
that passed the extractEntityId will be used
possibility to use a custom shard allocation and rebalancing logic
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.
the actor ref of the ShardRegion that is to be responsible for the shard
Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode,
i.e.
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 method.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
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.
The data center of the cluster nodes where the cluster sharding is running. If None then the same data center as current node.
functions to extract the entity id, shard id, and the message to send to the entity from the incoming message
the actor ref of the ShardRegion that is to be responsible for the shard
Java/Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode,
i.e.
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 method.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
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.
functions to extract the entity id, shard id, and the message to send to the entity from the incoming message
the actor ref of the ShardRegion that is to be responsible for the shard
Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode,
i.e.
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 method.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
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.
The data center of the cluster nodes where the cluster sharding is running. If None then the same data center as current node.
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
function to determine the shard id for an incoming message, only messages
that passed the extractEntityId will be used
the actor ref of the ShardRegion that is to be responsible for the shard
Scala API: Register a named entity type ShardRegion on this node that will run in proxy only mode,
i.e.
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 method.
Some settings can be configured as described in the akka.cluster.sharding section
of the reference.conf.
the name of the entity type
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.
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
function to determine the shard id for an incoming message, only messages
that passed the extractEntityId will be used
the actor ref of the ShardRegion that is to be responsible for the shard
ClusterSharding companion object