Click or drag to resize
Akka.NETClusterShardingStartProxyAsync Method (String, String, IMessageExtractor)
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(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
public Task<IActorRef> StartProxyAsync(
	string typeName,
	string role,
	IMessageExtractor messageExtractor
)

Parameters

typeName
Type: SystemString
The name of the entity type.
role
Type: SystemString
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
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