Class Passivate

If the state of the entities are persistent you may stop entities that are not used to reduce memory consumption. This is done by the application specific implementation of the entity actors for example by defining receive timeout (SetReceiveTimeout(TimeSpan?)). If a message is already enqueued to the entity when it stops itself the enqueued message in the mailbox will be dropped. To support graceful passivation without losing such messages the entity actor can send this Passivate message to its parent ShardRegion. The specified wrapped StopMessage will be sent back to the entity, which is then supposed to stop itself. Incoming messages will be buffered by the ShardRegion between reception of Passivate and termination of the entity. Such buffered messages are thereafter delivered to a new incarnation of the entity.

Instance is a perfectly fine StopMessage.

Inheritance

object

Passivate

Implements

IShardRegionCommand

Inherited Members

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

[Serializable]
public sealed class Passivate : IShardRegionCommand

Constructors

Passivate(object)

TBD

Declaration

public Passivate(object stopMessage)

Parameters

Type	Name	Description
object	stopMessage	TBD

Properties

StopMessage

TBD

Declaration

public object StopMessage { get; }

Property Value

Type	Description
object

Implements

IShardRegionCommand

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)