ShardManager class
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
Properties
- gatewayLatency → Duration
-
Average gateway latency across all shards
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxConcurrency → int
-
The number of identify requests allowed per 5 seconds
final
-
onConnected
→ Stream<
Shard> -
Emitted when the shard is ready.
latefinal
-
onDisconnect
→ Stream<
Shard> -
Emitted when the shard encounters a connection error.
latefinal
-
onMemberChunk
→ Stream<
MemberChunkEvent> -
Emitted when shard receives member chunk.
latefinal
-
onResume
→ Stream<
Shard> -
Emitted when the shard resumed its connection
latefinal
-
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.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
List of shards
no setter
Methods
-
dispose(
) → Future< void> -
Perform cleanup
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setPresence(
PresenceBuilder presenceBuilder) → void - Sets presences on every shard
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited