WebSocket class abstract

A two-way HTTP communication object for client or server applications.

The stream exposes the messages received. A text message will be of type String and a binary message will be of type List<int>.

Implemented types
Available extensions

Constructors

WebSocket()
WebSocket.fromUpgradedSocket(Socket socket, {String? protocol, bool? serverSide, CompressionOptions compression = CompressionOptions.compressionDefault})
Creates a WebSocket from an already-upgraded socket.
factory

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 setter
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 setter
done → Future
Return a future which is completed when the StreamSink is finished.
no setterinherited
extensions → String
The extensions property is initially the empty string. After the WebSocket connection is established this string reflects the extensions used by the server.
no setter
first → Future
The first element of this stream.
no setterinherited
firstOrNull → Future<T?>

Available on Stream<T>, provided by the StreamExtensions extension

A future which completes with the first event of this stream, or with null.
no setter
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
pingInterval ↔ Duration?
The interval between ping signals.
getter/setter pair
protocol → String?
The protocol property is initially the empty string. After the WebSocket connection is established the value is the subprotocol selected by the server. If no subprotocol is negotiated the value will remain null.
no setter
readyState → int
Returns the current state of the connection.
no setter
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 data) → void
Sends data on the WebSocket connection. The data in data must be either a String, or a List<int> holding bytes.
override
addError(Object error, [StackTrace? stackTrace]) → void
Adds an error to the sink.
inherited
addStream(Stream stream) → Future
Sends data from a stream on WebSocket connection. Each data event from stream will be send as a single WebSocket frame. The data from stream must be either Strings, or List<int>s holding bytes.
override
addUtf8Text(List<int> bytes) → void
Sends a text message with the text represented by bytes.
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
Closes the WebSocket connection. Set the optional code and reason arguments to send close information to the remote peer. If they are omitted, the peer will see WebSocketStatus.noStatusReceived code with no reason.
override
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
listenAndBuffer() → Stream<T>

Available on Stream<T>, provided by the StreamExtensions extension

Eagerly listens to this stream and buffers events until needed.
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
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
rejectErrors() → StreamSink<T>

Available on StreamSink<T>, provided by the StreamSinkExtensions extension

Returns a StreamSink that forwards to this but rejects errors.
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
slices(int length) → Stream<List<T>>

Available on Stream<T>, provided by the StreamExtensions extension

Creates a stream whose elements are contiguous slices of this.
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
transform<S>(StreamSinkTransformer<S, T> transformer) → StreamSink<S>

Available on StreamSink<T>, provided by the StreamSinkExtensions extension

Transforms a StreamSink using transformer.
where(bool test(dynamic event)) → Stream
Creates a new stream from this stream that discards some elements.
inherited

Operators

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

Static Properties

userAgent ↔ String?
Gets the user agent used for WebSocket connections.
getter/setter pair

Static Methods

connect(String url, {Iterable<String>? protocols, Map<String, dynamic>? headers, CompressionOptions compression = CompressionOptions.compressionDefault, HttpClient? customClient}) → Future<WebSocket>
Create a new WebSocket connection. The URL supplied in url must use the scheme ws or wss.

Constants

closed → const int
closing → const int
connecting → const int
Possible states of the connection.
open → const int