PassivationPolicyUnion

PackageFCQRS
Idle passivation for an aggregate type, set per entity at registration. Passivation stops an idle actor and releases its in-memory state; the next command recovers it from the journal. Only messages routed through cluster sharding count as activity. Sagas ignore this: their shard regions remember entities, which disables idle passivation in Akka.NET. A saga stops at StopSaga or abort instead.

Specification

Kind
Union
Members
6
Examples
0
IsAfterSignature
this.IsAfter
IsDefaultSignature
this.IsDefault
IsNeverSignature
this.IsNever
DefaultSignature
Default
AfterSignature
After TimeSpan

Summary

NameSignatureSynopsis
IsAfterthis.IsAfterNo description available.
IsDefaultthis.IsDefaultNo description available.
IsNeverthis.IsNeverNo description available.
DefaultDefaultUse configuration: `akka.cluster.sharding.<EntityName>.passivate-idle-entity-after`, then `akka.cluster.sharding.passivate-idle-entity-after`, then Akka.NET's 120s.
AfterAfter TimeSpanPassivate after this idle period, overriding configuration.
NeverNeverNever passivate on idle.

IsAfter

this.IsAfter
Member

Returns

bool

IsDefault

this.IsDefault
Member

Returns

bool

IsNever

this.IsNever
Member

Returns

bool

Default

Default
Member
Use configuration: `akka.cluster.sharding.<EntityName>.passivate-idle-entity-after`, then `akka.cluster.sharding.passivate-idle-entity-after`, then Akka.NET's 120s.

Returns

unit

After

After TimeSpan
Member
Passivate after this idle period, overriding configuration. A non-positive value means Never.

Parameters

NameTypeDescription
ItemTimeSpan

Returns

unit

Never

Never
Member
Never passivate on idle. The entity stays resident until the node stops or the shard moves, so recovery cost is traded for memory held indefinitely.

Returns

unit