Class ShardRegion

INTERNAL API

This actor creates children shard actors on demand that it is told to be responsible for. The shard actors in turn create entity actors on demand. It delegates messages targeted to other shards to the responsible ShardRegion actor on other nodes.

Inheritance
Object
ActorBase
ShardRegion
Implements
Inherited Members
Namespace: Akka.Cluster.Sharding
Assembly: Akka.Cluster.Sharding.dll
Syntax
public sealed class ShardRegion : ActorBase, IInternalActor, IWithTimers

Constructors

| Improve this Doc View Source

ShardRegion(String, Func<String, Props>, ClusterShardingSettings, String, IMessageExtractor, Object, IRememberEntitiesProvider)

TBD

Declaration
public ShardRegion(string typeName, Func<string, Props> entityProps, ClusterShardingSettings settings, string coordinatorPath, IMessageExtractor messageExtractor, object handOffStopMessage, IRememberEntitiesProvider rememberEntitiesProvider)
Parameters
Type Name Description
String typeName

TBD
Func<String, Props> entityProps

TBD
ClusterShardingSettings settings

TBD
String coordinatorPath

TBD
IMessageExtractor messageExtractor
Object handOffStopMessage

TBD
IRememberEntitiesProvider rememberEntitiesProvider

TBD

Properties

| Improve this Doc View Source

Timers

Declaration
public ITimerScheduler Timers { get; set; }
Property Value
Type Description
ITimerScheduler

Methods

| Improve this Doc View Source

PostStop()

User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

Declaration
protected override void PostStop()
Overrides
| Improve this Doc View Source

PreStart()

Subscribe to MemberEvent, re-subscribe when restart

Declaration
protected override void PreStart()
Overrides
| Improve this Doc View Source

Receive(Object)

Processor for user defined messages.

Declaration
protected override bool Receive(object message)
Parameters
Type Name Description
Object message

The message.
Returns
Type Description
Boolean

TBD
Overrides

Implements

Extension Methods