Class GetClusterShardingStats

Send this message to the ShardRegion actor to request for ClusterShardingStats, which contains statistics about the currently running sharded entities in the entire cluster. If the timeout is reached without answers from all shard regions the reply will contain an empty map of regions.

Intended for testing purpose to see when cluster sharding is "ready" or to monitor the state of the shard regions.

Inheritance
Object
GetClusterShardingStats
Implements
Inherited Members
Namespace: Akka.Cluster.Sharding
Assembly: Akka.Cluster.Sharding.dll
Syntax
[Serializable]
public sealed class GetClusterShardingStats : IShardRegionQuery, IClusterShardingSerializable, IEquatable<GetClusterShardingStats>

Constructors

| Improve this Doc View Source

GetClusterShardingStats(TimeSpan)

Creates a new GetClusterShardingStats message instance.

Declaration
public GetClusterShardingStats(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

The amount of time to allow this operation to run.

Fields

| Improve this Doc View Source

Timeout

The timeout for this operation.

Declaration
public readonly TimeSpan Timeout
Field Value
Type Description
TimeSpan

Methods

| Improve this Doc View Source

Equals(GetClusterShardingStats)

Declaration
public bool Equals(GetClusterShardingStats other)
Parameters
Type Name Description
GetClusterShardingStats other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods