WebSocketChannel class abstract interface

A StreamChannel that communicates over a WebSocket.

This is implemented by classes that use dart:io and dart:html. The WebSocketChannel.new constructor can also be used on any platform to connect to use the WebSocket protocol over a pre-existing channel.

All implementations emit WebSocketChannelExceptions. These exceptions wrap the native exception types where possible.

Inheritance
  • Object
  • StreamChannelMixin
  • WebSocketChannel
Implementers

Properties

closeCode → int?
The close code set when the WebSocket connection is closed.
no setter
closeReason → String?
The close reason set when the WebSocket connection is closed.
no setter
hashCode → int
The hash code for this object.
no setterinherited
protocol → String?
The subprotocol selected by the server.
no setter
ready → Future<void>
A future that will complete when the WebSocket connection has been established.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sink → WebSocketSink
The sink for sending values to the other endpoint.
no setteroverride
stream → Stream
The single-subscription stream that emits values from the other endpoint.
no setterinherited

Methods

cast<S>() → StreamChannel<S>
Returns a copy of this with the generic type coerced to S.
inherited
changeSink(StreamSink change(StreamSink)) → StreamChannel
Returns a copy of this with sink replaced by change's return value.
inherited
changeStream(Stream change(Stream)) → StreamChannel
Returns a copy of this with stream replaced by change's return value.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pipe(StreamChannel other) → void
Connects this to other, so that any values emitted by either are sent directly to the other.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamChannelTransformer<S, dynamic> transformer) → StreamChannel<S>
Transforms this using transformer.
inherited
transformSink(StreamSinkTransformer transformer) → StreamChannel
Transforms only the sink component of this using transformer.
inherited
transformStream(StreamTransformer transformer) → StreamChannel
Transforms only the stream component of this using transformer.
inherited

Operators

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

Static Methods

connect(Uri uri, {Iterable<String>? protocols}) → WebSocketChannel
Creates a new WebSocket connection.
signKey(String key) → String
Signs a Sec-WebSocket-Key header sent by a WebSocket client as part of the initial handshake.