Click or drag to resize
Akka.NETPassivate Class
If the state of the entries are persistent you may stop entries 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(NullableTimeSpan)). 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 loosing 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. PoisonPill is a perfectly fine StopMessage.
Inheritance Hierarchy
SystemObject
  Akka.Cluster.ShardingPassivate

Namespace:  Akka.Cluster.Sharding
Assembly:  Akka.Cluster.Sharding (in Akka.Cluster.Sharding.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
[SerializableAttribute]
public sealed class Passivate : IShardRegionCommand

The Passivate type exposes the following members.

Constructors
  NameDescription
Public methodPassivate
TBD
Top
Properties
  NameDescription
Public propertyStopMessage
TBD
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
See Also