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

int CLOSED = 3
const
int CLOSING = 2
const
int CONNECTING = 0
const
Possible states of the connection.
int OPEN = 1
const

Static Methods

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

Properties

int closeCode
read-only
The close code set when the WebSocket connection is closed. If there is no close code available this property will be null
String closeReason
read-only
The close reason set when the WebSocket connection is closed. If there is no close reason available this property will be null
Future done
read-only, inherited
Return a future which is completed when the StreamSink is finished.
String extensions
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.
Future first
read-only, inherited
Returns the first element of the stream.
bool isBroadcast
read-only, inherited
Reports whether this stream is a broadcast stream.
Future<bool> isEmpty
read-only, inherited
Reports whether this stream contains any elements.
Future last
read-only, inherited
Returns the last element of the stream.
Future<int> length
read-only, inherited
Counts the elements in the stream.
Duration pingInterval
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.
String protocol
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.
int readyState
read-only
Returns the current state of the connection.
Future single
read-only, inherited
Returns the single element.

Constructors

WebSocket()
WebSocket.fromUpgradedSocket(Socket socket, {String protocol, bool serverSide})
Creates a WebSocket from an already-upgraded socket.

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.
addError(errorEvent, [StackTrace stackTrace]) → void
inherited
Send an async error to a stream.
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.
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(Stream convert(T event)) → Stream
inherited
Creates a new stream with the events of a stream per original event.
asyncMap(dynamic convert(T event)) → Stream
inherited
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
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.
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([futureValue]) → Future
inherited
Discards all data on the stream, but signals when it's done or an error occured.
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(Iterable convert(T value)) → Stream
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(initialValue, dynamic combine(previous, T element)) → Future
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(dynamic convert(T event)) → Stream
inherited
Creates a new stream that converts each element of this stream to a new value using the convert function.
pipe(StreamConsumer streamConsumer) → Future
inherited
Pipe the events of this stream into streamConsumer.
reduce(T 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 n values of this stream.
takeWhile(bool test(T 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 the data of this stream in a List.
toSet() → Future<Set>
inherited
Collects the data of this stream in a Set.
transform(StreamTransformer streamTransformer) → Stream
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.