Header menu logo FCQRS

PassivationPolicy Type

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.

Union cases

Union case Description

After TimeSpan

Full Usage: After TimeSpan

Parameters:

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

Item : TimeSpan

Default

Full Usage: Default

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

Never

Full Usage: Never

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.

Instance members

Instance member Description

this.IsAfter

Full Usage: this.IsAfter

Returns: bool
Returns: bool

this.IsDefault

Full Usage: this.IsDefault

Returns: bool
Returns: bool

this.IsNever

Full Usage: this.IsNever

Returns: bool
Returns: bool

Type something to start searching.