Click or drag to resize
Akka.NETClusterShardingStartAsync Method (String, Props, ClusterShardingSettings, IMessageExtractor)
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.129 (1.2.3.129)
Syntax
Copy
public Task<IActorRef> StartAsync(
	string typeName,
	Props entityProps,
	ClusterShardingSettings settings,
	IMessageExtractor messageExtractor
)

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.

Return Value

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