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

| Edit this page 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

| Edit this page View Source

Timeout

The timeout for this operation.

Declaration
public readonly TimeSpan Timeout
Field Value
Type Description
TimeSpan

Methods

| Edit this page View Source

Equals(GetClusterShardingStats)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(GetClusterShardingStats other)
Parameters
Type Name Description
GetClusterShardingStats other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
| Edit this page View Source

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
| Edit this page View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
| Edit this page View Source

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides

Implements

Extension Methods