WebSocket abstract 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>.

Implements

Constants

CLOSED → int: 3
CLOSING → int: 2
CONNECTING → int: Possible states of the connection.

0
OPEN → int: 1

Static Methods

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

Constructors

WebSocket()
WebSocket.fromUpgradedSocket(Socket socket, { String protocol, bool serverSide, CompressionOptions compression: CompressionOptions.DEFAULT }) 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
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.
pingInterval → Duration read / write: Set and get the interval for sending ping signals. If a ping message is not answered by a pong message from the peer, the WebSocket is assumed disconnected and the connection is closed with a WebSocketStatus.GOING_AWAY close code. When a ping signal is sent, the pong message must be received within pingInterval.
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.
done → Future read-only, inherited: Return a future which is completed when the StreamSink is finished.
first → Future read-only, inherited: Returns the first element of the 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: Reports whether this stream contains any elements.
last → Future read-only, inherited: Returns the last element of the stream.
length → Future<int> read-only, inherited: Counts the elements in the stream.
runtimeType → Type read-only, inherited: A representation of the runtime type of the object.
single → Future read-only, inherited: Returns the single element.

Operators

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

Methods

add(data) → void: Sends data on the WebSocket connection. The data in data must be either a String, or a List<int> holding bytes.
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.
addUtf8Text(List<int> bytes) → void: Sends a text message with the text represented by bytes.
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.NO_STATUS_RECEIVED code with no reason.
addError(Object error, [ StackTrace stackTrace ]) → void inherited: Adds an error to the sink.
any(bool test(T element)) → Future<bool> inherited: Checks whether test accepts any element provided by this stream.
asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription) }) → Stream inherited: Returns a multi-subscription stream that produces the same events as this.
asyncExpand<E>(Stream<E> convert(T event)) → Stream<E> inherited: Creates a new stream with the events of a stream per original event.
asyncMap<E>(dynamic convert(T event)) → Stream<E> inherited: Creates a new stream with each data event of this stream asynchronously mapped to a new event.
contains(Object needle) → Future<bool> inherited: Checks whether needle occurs in the elements provided by this stream.
distinct([bool equals(T previous, T 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 the stream, but signals when it's done or an error occurred.
elementAt(int index) → Future inherited: Returns the value of the indexth data event of this stream.
every(bool test(T element)) → Future<bool> inherited: Checks whether test accepts all elements provided by this stream.
expand<S>(Iterable<S> convert(T value)) → Stream<S> inherited: Creates a new stream from this stream that converts each element into zero or more events.
firstWhere(bool test(T element), { Object defaultValue() }) → Future inherited: Finds the first element of this stream matching test.
fold<S>(S initialValue, S combine(S previous, T element)) → Future<S> inherited: Reduces a sequence of values by repeatedly applying combine.
forEach(void action(T element)) → Future inherited: Executes action on each data event of the stream.
handleError(Function onError, { bool test(error) }) → Stream inherited: Creates a wrapper Stream that intercepts some errors from this stream.
join([String separator = "" ]) → Future<String> inherited: Collects string of data events' string representations.
lastWhere(bool test(T element), { Object defaultValue() }) → Future inherited: Finds the last element in this stream matching test.
listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription inherited: Adds a subscription to this stream.
map<S>(S convert(T event)) → Stream<S> inherited: Creates a new stream that converts each element of this stream to a new value using the convert function.
noSuchMethod(Invocation invocation) → dynamic inherited: Invoked when a non-existent method or property is accessed.
pipe(StreamConsumer streamConsumer) → Future inherited: Pipe the events of this stream into streamConsumer.
reduce(dynamic combine(T previous, T element)) → Future inherited: Reduces a sequence of values by repeatedly applying combine.
singleWhere(bool test(T element)) → 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(T 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(T element)) → Stream inherited: Forwards data events while test is successful.
timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream inherited: Creates a new stream with the same events as this stream.
toList() → Future<List> inherited: Collects the data of this stream in a List.
toSet() → Future<Set> inherited: Collects the data of this stream in a Set.
toString() → String inherited: Returns a string representation of this object.
transform<S>(StreamTransformer<dynamic, S> streamTransformer) → Stream<S> inherited: Chains this stream as the input of the provided StreamTransformer.
where(bool test(T event)) → Stream inherited: Creates a new stream from this stream that discards some data events.

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