- Implemented types
-
- Annotations
-
Properties
-
closeCode
→ int?
-
The close code set when the WebSocket connection is closed. If there is
no close code available this property will be
null.
no setterinherited
-
closeReason
→ String?
-
The close reason set when the WebSocket connection is closed. If there is
no close reason available this property will be
null.
no setterinherited
-
done
→ Future<Null>
-
Future that resolves when this WebSocket connection has completely closed.
no setterinherited
-
first
→ Future
-
The first element of this stream.
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
isBroadcast
→ bool
-
Whether this stream is a broadcast stream.
no setterinherited
-
isEmpty
→ Future<bool>
-
Whether this stream contains any elements.
no setterinherited
-
last
→ Future
-
The last element of this stream.
no setterinherited
-
length
→ Future<int>
-
The number of elements in this stream.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
single
→ Future
-
The single element of this stream.
no setterinherited
Methods
-
add(dynamic message)
→ void
-
Sends a message over the WebSocket connection.
inherited
-
addError(Object errorEvent, [StackTrace? stackTrace])
→ void
-
Add an error to the sink. This will cause the WebSocket connection to close.
inherited
-
addIncoming(dynamic data)
→ void
-
Simulate an incoming message that the owner of this
WSocket instance
will receive if listening.
inherited
-
addStream(Stream stream)
→ Future<Null>
-
Adds a stream of data to send over the WebSocket connection.
This will wait for the stream to complete, sending each element
as it is received.
inherited
-
any(bool test(dynamic element))
→ Future<bool>
-
Checks whether
test accepts any element provided by this stream.
inherited
-
asBroadcastStream({void onListen(StreamSubscription subscription)?, void onCancel(StreamSubscription subscription)?})
→ Stream
-
Returns a multi-subscription stream that produces the same events as this.
inherited
-
asyncExpand<E>(Stream<E>? convert(dynamic event))
→ Stream<E>
-
Transforms each element into a sequence of asynchronous events.
inherited
-
asyncMap<E>(FutureOr<E> convert(dynamic 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([int? code, String? reason])
→ Future<Null>
-
Closes the WebSocket connection. Optionally set
code and reason
to send close information to the remote peer.
inherited
-
contains(Object? needle)
→ Future<bool>
-
Returns whether
needle occurs in the elements provided by this stream.
inherited
-
distinct([bool equals(dynamic previous, dynamic next)?])
→ Stream
-
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
-
Returns the value of the
indexth data event of this stream.
inherited
-
every(bool test(dynamic element))
→ Future<bool>
-
Checks whether
test accepts all elements provided by this stream.
inherited
-
expand<S>(Iterable<S> convert(dynamic element))
→ Stream<S>
-
Transforms each element of this stream into a sequence of elements.
inherited
-
firstWhere(bool test(dynamic element), {dynamic orElse()?})
→ Future
-
Finds the first element of this stream matching
test.
inherited
-
fold<S>(S initialValue, S combine(S previous, dynamic element))
→ Future<S>
-
Combines a sequence of values by repeatedly applying
combine.
inherited
-
forEach(void action(dynamic element))
→ Future<void>
-
Executes
action on each element of this stream.
inherited
-
handleError(Function onError, {bool test(dynamic error)?})
→ Stream
-
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(dynamic element), {dynamic orElse()?})
→ Future
-
Finds the last element in this stream matching
test.
inherited
-
listen(void onData(dynamic event)?, {Function? onError, void onDone()?, bool? cancelOnError})
→ StreamSubscription
-
Adds a subscription to this stream.
inherited
-
map<S>(S convert(dynamic 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
-
onOutgoing(dynamic callback(dynamic data))
→ void
-
Register a callback that will be called for every outgoing data event that
the owner of this
WSocket instance adds.
inherited
-
pipe(StreamConsumer streamConsumer)
→ Future
-
Pipes the events of this stream into
streamConsumer.
inherited
-
reduce(dynamic combine(dynamic previous, dynamic element))
→ Future
-
Combines a sequence of values by repeatedly applying
combine.
inherited
-
singleWhere(bool test(dynamic element), {dynamic orElse()?})
→ Future
-
Finds the single element in this stream matching
test.
inherited
-
skip(int count)
→ Stream
-
Skips the first
count data events from this stream.
inherited
-
skipWhile(bool test(dynamic element))
→ Stream
-
Skip data events from this stream while they are matched by
test.
inherited
-
take(int count)
→ Stream
-
Provides at most the first
count data events of this stream.
inherited
-
takeWhile(bool test(dynamic element))
→ Stream
-
Forwards data events while
test is successful.
inherited
-
timeout(Duration timeLimit, {void onTimeout(EventSink sink)?})
→ Stream
-
Creates a new stream with the same events as this stream.
inherited
-
toList()
→ Future<List>
-
Collects all elements of this stream in a List.
inherited
-
toSet()
→ Future<Set>
-
Collects the data of this stream in a Set.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
transform<S>(StreamTransformer<dynamic, S> streamTransformer)
→ Stream<S>
-
Applies
streamTransformer to this stream.
inherited
-
triggerServerClose([int? code, String? reason])
→ void
-
Cause the "server" to close, effectively severing the connection between
the server and client.
inherited
-
triggerServerError(Object error, [StackTrace? stackTrace])
→ void
-
Cause the "server" to add an error to the stream.
inherited
-
where(bool test(dynamic event))
→ Stream
-
Creates a new stream from this stream that discards some elements.
inherited
