ShardManager class Null safety

Spawns, connects, monitors, manages and terminates shards. Sharding will be automatic if no user settings are supplied in ClientOptions when instantiating Nyxx client instance.

Discord gateways implement a method of user-controlled guild sharding which allows for splitting events across a number of gateway connections. Guild sharding is entirely user controlled, and requires no state-sharing between separate connections to operate.

Implemented types


gatewayLatency Duration
Average gateway latency across all shards
hashCode int
The hash code for this object. [...]
read-only, inherited
maxConcurrency int
The number of identify requests allowed per 5 seconds
onConnected Stream<Shard>
Emitted when the shard is ready.
late, final
onDisconnect Stream<Shard>
Emitted when the shard encounters a connection error.
late, final
onMemberChunk Stream<MemberChunkEvent>
Emitted when shard receives member chunk.
late, final
onResume Stream<Shard>
Emitted when the shard resumed its connection
late, final
rawEvent Stream<RawEvent>
Raw gateway payloads. You have set dispatchRawShardEvent in ClientOptions to true otherwise stream won't receive any events. Also rawEvent is dispatched ONLY for payload that doesn't match any event built in into Nyxx.
late, final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
shards Iterable<Shard>
List of shards


dispose() Future<void>
Perform cleanup
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
setPresence(PresenceBuilder presenceBuilder) → void
Sets presences on every shard
toString() String
A string representation of this object. [...]


operator ==(Object other) bool
The equality operator. [...]