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

IInternalActor

IWithTimers

Inherited Members

ActorBase.AroundPreRestart(Exception, object)

ActorBase.AroundPreStart()

ActorBase.AroundPostRestart(Exception, object)

ActorBase.AroundPostStop()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Cluster.Sharding

Assembly: Akka.Cluster.Sharding.dll

Syntax

public sealed class ShardRegion : ActorBase, IInternalActor, IWithTimers

Constructors

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

Timers

Gets or sets the TimerScheduler. This will be automatically populated by the framework in base constructor. Implement this as an auto property.

Declaration

public ITimerScheduler Timers { get; set; }

Property Value

Type	Description
ITimerScheduler

Methods

PostStop()

User overridable callback.

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

Declaration

protected override void PostStop()

Overrides

ActorBase.PostStop()

PreStart()

User overridable callback.

Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

Declaration

protected override void PreStart()

Overrides

ActorBase.PreStart()

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
bool	TBD

Overrides

ActorBase.Receive(object)

Implements

IInternalActor

IWithTimers

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)