/// <summary>
/// Register a named entity type by defining the <see cref="Actor.Props"/> of the entity actor and
/// functions to extract entity and shard identifier from messages. The <see cref="Sharding.ShardRegion"/>
/// actor for this type can later be retrieved with the <see cref="ShardRegion"/> method.
/// </summary>
/// <param name="typeName">The name of the entity type</param>
/// <param name="entityProps">
/// The <see cref="Actor.Props"/> of the entity actors that will be created by the <see cref="Sharding.ShardRegion"/>
/// </param>
/// <param name="settings">Configuration settings, see <see cref="ClusterShardingSettings"/></param>
/// <param name="idExtractor">
/// 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
/// </param>
/// <param name="shardResolver">
/// Function to determine the shard id for an incoming message, only messages that passed the `extractEntityId` will be used
/// </param>
/// <param name="allocationStrategy">Possibility to use a custom shard allocation and rebalancing logic</param>
/// <param name="handOffStopMessage">
/// The message that will be sent to entities when they are to be stopped for a rebalance or
/// graceful shutdown of a <see cref="Sharding.ShardRegion"/>, e.g. <see cref="PoisonPill"/>.
/// </param>
/// <returns>The actor ref of the <see cref="Sharding.ShardRegion"/> that is to be responsible for the shard.</returns>
public IActorRef Start(
string typeName, //TODO: change type name to type instance?
Props entityProps,
ClusterShardingSettings settings,
IdExtractor idExtractor,
ShardResolver shardResolver,
IShardAllocationStrategy allocationStrategy,
object handOffStopMessage)
{
RequireClusterRole(settings.Role);
var timeout = _system.Settings.CreationTimeout;
var startMsg = new ClusterShardingGuardian.Start(typeName, entityProps, settings, idExtractor, shardResolver, allocationStrategy, handOffStopMessage);
var started = _guardian.Value.Ask <ClusterShardingGuardian.Started>(startMsg, timeout).Result;
var shardRegion = started.ShardRegion;
_regions.TryAdd(typeName, shardRegion);
return(shardRegion);
}
/// <summary>
/// Register a named entity type by defining the <see cref="Actor.Props"/> of the entity actor and
/// functions to extract entity and shard identifier from messages. The <see cref="Sharding.ShardRegion"/>
/// actor for this type can later be retrieved with the <see cref="ShardRegion"/> method.
/// </summary>
/// <param name="typeName">The name of the entity type</param>
/// <param name="entityProps">
/// The <see cref="Actor.Props"/> of the entity actors that will be created by the <see cref="Sharding.ShardRegion"/>
/// </param>
/// <param name="settings">Configuration settings, see <see cref="ClusterShardingSettings"/></param>
/// <param name="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
/// </param>
/// <param name="extractShardId">
/// Function to determine the shard id for an incoming message, only messages that passed the `extractEntityId` will be used
/// </param>
/// <param name="allocationStrategy">Possibility to use a custom shard allocation and rebalancing logic</param>
/// <param name="handOffStopMessage">
/// The message that will be sent to entities when they are to be stopped for a rebalance or
/// graceful shutdown of a <see cref="Sharding.ShardRegion"/>, e.g. <see cref="PoisonPill"/>.
/// </param>
/// <exception cref="IllegalStateException">
/// This exception is thrown when the cluster member doesn't have the role specified in <paramref name="settings"/>.
/// </exception>
/// <returns>The actor ref of the <see cref="Sharding.ShardRegion"/> that is to be responsible for the shard.</returns>
public IActorRef Start(
string typeName,
Props entityProps,
ClusterShardingSettings settings,
ExtractEntityId extractEntityId,
ExtractShardId extractShardId,
IShardAllocationStrategy allocationStrategy,
object handOffStopMessage)
{
RequireClusterRole(settings.Role);
var timeout = _system.Settings.CreationTimeout;
var startMsg = new ClusterShardingGuardian.Start(typeName, entityProps, settings, extractEntityId, extractShardId, allocationStrategy, handOffStopMessage);
var started = _guardian.Value.Ask <ClusterShardingGuardian.Started>(startMsg, timeout).Result;
var shardRegion = started.ShardRegion;
_regions.TryAdd(typeName, shardRegion);
return(shardRegion);
}
