Click or drag to resize
Akka.NETClusterShardingStart Method (String, Props, ClusterShardingSettings, IMessageExtractor, IShardAllocationStrategy, Object)
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(String) method.

Namespace:  Akka.Cluster.Sharding
Assembly:  Akka.Cluster.Sharding (in Akka.Cluster.Sharding.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
Copy
public IActorRef Start(
	string typeName,
	Props entityProps,
	ClusterShardingSettings settings,
	IMessageExtractor messageExtractor,
	IShardAllocationStrategy allocationStrategy,
	Object handOffMessage
)

Parameters

typeName
Type: SystemString
The name of the entity type
entityProps
Type: Akka.ActorProps
The Props of the entity actors that will be created by the ShardRegion
settings
Type: Akka.Cluster.ShardingClusterShardingSettings
Configuration settings, see ClusterShardingSettings
messageExtractor
Type: Akka.Cluster.ShardingIMessageExtractor
Functions to extract the entity id, shard id, and the message to send to the entity from the incoming message.
allocationStrategy
Type: Akka.Cluster.ShardingIShardAllocationStrategy
Possibility to use a custom shard allocation and rebalancing logic
handOffMessage
Type: SystemObject
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.

Return Value

Type: IActorRef
The actor ref of the ShardRegion that is to be responsible for the shard.
See Also