Click or drag to resize
Akka.NETClusterShardingStartProxy Method (String, String, IdExtractor, ShardResolver)
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
Copy
public IActorRef StartProxy(
	string typeName,
	string role,
	IdExtractor idExtractor,
	ShardResolver shardResolver
)

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.
idExtractor
Type: Akka.Cluster.ShardingIdExtractor
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
shardResolver
Type: Akka.Cluster.ShardingShardResolver
Function to determine the shard id for an incoming message, only messages that passed the `extractEntityId` will be used

Return Value

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