Shard class

A single connection to Discord's Gateway.

Inheritance
Implemented types

Constructors

Shard(int id, Isolate isolate, Stream receiveStream, SendPort sendPort, NyxxGateway client)
Create a new Shard.

Properties

client → NyxxGateway
The client this Shard is for.
final
done → Future<void>
Return a future which is completed when the StreamSink is finished.
no setteroverride
first → Future<ShardMessage>
The first element of this stream.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → int
The ID of this shard.
final
isBroadcast → bool
Whether this stream is a broadcast stream.
no setterinherited
isEmpty → Future<bool>
Whether this stream contains any elements.
no setterinherited
isolate → Isolate
The isolate this shard's handler is running in.
final
last → Future<ShardMessage>
The last element of this stream.
no setterinherited
latency → Duration
The latency on this shard's connection.
no setter
length → Future<int>
The number of elements in this stream.
no setterinherited
logger → Logger
The logger used by this shard.
no setter
receiveStream → Stream
The stream on which events from the runner are received.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sendPort → SendPort
The port on which events are sent to the runner.
final
single → Future<ShardMessage>
The single element of this stream.
no setterinherited

Methods

add(GatewayMessage event) → void
Adds a data event to the sink.
override
addError(Object error, [StackTrace? stackTrace]) → void
Adds an error to the sink.
override
addStream(Stream<GatewayMessage> stream) → Future<void>
Consumes the elements of stream.
override
any(bool test(ShardMessage element)) → Future<bool>
Checks whether test accepts any element provided by this stream.
inherited
asBroadcastStream({void onListen(StreamSubscription<ShardMessage> subscription)?, void onCancel(StreamSubscription<ShardMessage> subscription)?}) → Stream<ShardMessage>
Returns a multi-subscription stream that produces the same events as this.
inherited
asyncExpand<E>(Stream<E>? convert(ShardMessage event)) → Stream<E>
Transforms each element into a sequence of asynchronous events.
inherited
asyncMap<E>(FutureOr<E> convert(ShardMessage event)) → Stream<E>
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
inherited
cast<R>() → Stream<R>
Adapt this stream to be a Stream<R>.
inherited
close() → Future<void>
Tells the stream sink that no further streams will be added.
override
contains(Object? needle) → Future<bool>
Returns whether needle occurs in the elements provided by this stream.
inherited
distinct([bool equals(ShardMessage previous, ShardMessage next)?]) → Stream<ShardMessage>
Skips data events if they are equal to the previous data event.
inherited
drain<E>([E? futureValue]) → Future<E>
Discards all data on this stream, but signals when it is done or an error occurred.
inherited
elementAt(int index) → Future<ShardMessage>
Returns the value of the indexth data event of this stream.
inherited
every(bool test(ShardMessage element)) → Future<bool>
Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(ShardMessage element)) → Stream<S>
Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(ShardMessage element), {ShardMessage orElse()?}) → Future<ShardMessage>
Finds the first element of this stream matching test.
inherited
fold<S>(S initialValue, S combine(S previous, ShardMessage element)) → Future<S>
Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(ShardMessage element)) → Future<void>
Executes action on each element of this stream.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<ShardMessage>
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
join([String separator = ""]) → Future<String>
Combines the string representation of elements into a single string.
inherited
lastWhere(bool test(ShardMessage element), {ShardMessage orElse()?}) → Future<ShardMessage>
Finds the last element in this stream matching test.
inherited
listen(void onData(ShardMessage event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<ShardMessage>
Adds a subscription to this stream.
override
map<S>(S convert(ShardMessage event)) → Stream<S>
Transforms each element of this stream into a new stream event.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pipe(StreamConsumer<ShardMessage> streamConsumer) → Future
Pipes the events of this stream into streamConsumer.
inherited
reduce(ShardMessage combine(ShardMessage previous, ShardMessage element)) → Future<ShardMessage>
Combines a sequence of values by repeatedly applying combine.
inherited
singleWhere(bool test(ShardMessage element), {ShardMessage orElse()?}) → Future<ShardMessage>
Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<ShardMessage>
Skips the first count data events from this stream.
inherited
skipWhile(bool test(ShardMessage element)) → Stream<ShardMessage>
Skip data events from this stream while they are matched by test.
inherited
take(int count) → Stream<ShardMessage>
Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(ShardMessage element)) → Stream<ShardMessage>
Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<ShardMessage> sink)?}) → Stream<ShardMessage>
Creates a new stream with the same events as this stream.
inherited
toList() → Future<List<ShardMessage>>
Collects all elements of this stream in a List.
inherited
toSet() → Future<Set<ShardMessage>>
Collects the data of this stream in a Set.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamTransformer<ShardMessage, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
inherited
updateVoiceState(Snowflake guildId, GatewayVoiceStateBuilder builder) → void
Update the client's voice state on this shard.
where(bool test(ShardMessage event)) → Stream<ShardMessage>
Creates a new stream from this stream that discards some elements.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

connect(int id, int totalShards, GatewayApiOptions apiOptions, Uri connectionUri, NyxxGateway client) → Future<Shard>
Connect to the Gateway using the provided parameters.