WebSocket class

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

Constructors

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

Properties

closeCode → int? read-only: The close code set when the WebSocket connection is closed. If there is no close code available this property will be null
closeReason → String? read-only: The close reason set when the WebSocket connection is closed. If there is no close reason available this property will be null
done → Future read-only, inherited: Return a future which is completed when the StreamSink is finished. [...]
extensions → String read-only: The extensions property is initially the empty string. After the WebSocket connection is established this string reflects the extensions used by the server.
first → Future read-only, inherited: The first element of this stream. [...]
hashCode → int read-only, inherited: The hash code for this object. [...]
isBroadcast → bool read-only, inherited: Whether this stream is a broadcast stream.
isEmpty → Future<bool> read-only, inherited: Whether this stream contains any elements. [...]
last → Future read-only, inherited: The last element of this stream. [...]
length → Future<int> read-only, inherited: The number of elements in this stream. [...]
pingInterval ↔ Duration? read / write: The interval between ping signals. [...]
protocol → String? read-only: 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.
readyState → int read-only: Returns the current state of the connection.
runtimeType → Type read-only, inherited: A representation of the runtime type of the object.
single → Future read-only, inherited: The single element of this stream. [...]

Methods

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

Operators

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

Static Properties

userAgent ↔ String? read / write: Gets the user agent used for WebSocket connections.

Static Methods

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

Constants

CLOSED → const int @Deprecated("Use closed instead"): closed
closed → const int: 3
CLOSING → const int @Deprecated("Use closing instead"): closing
closing → const int: 2
CONNECTING → const int @Deprecated("Use connecting instead"): connecting
connecting → const int: Possible states of the connection.
0
OPEN → const int @Deprecated("Use open instead"): open
open → const int: 1

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dart.dev/stable/2.13.0/dart-io/WebSocket-class.html