IOWebSocketChannel class

A WebSocketChannel that communicates using a dart:io WebSocket.

Inheritance
  • Object
  • StreamChannelMixin
  • IOWebSocketChannel
Implemented types

Constructors

IOWebSocketChannel(WebSocket socket)
Creates a channel wrapping socket.
IOWebSocketChannel.connect(Object url, {Iterable<String>? protocols, Map<String, dynamic>? headers, Duration? pingInterval, Duration? connectTimeout, HttpClient? customClient})
Creates a new WebSocket connection.
factory

Properties

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

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