BrowserWebSocket class

A WebSocket using the browser WebSocket API.

Usable when targeting the browser using either JavaScript or WASM.

Implemented types

Properties

events Stream<WebSocketEvent>
A Stream of WebSocketEvent received from the peer.
no setteroverride
hashCode int
The hash code for this object.
no setterinherited
protocol String
The WebSocket subprotocol negotiated with the peer.
no setteroverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

close([int? code, String? reason]) Future<void>
Closes the WebSocket connection and the events Stream.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendBytes(Uint8List b) → void
Sends binary data to the connected peer.
override
sendText(String s) → void
Sends text data to the connected peer.
override
toString() String
A string representation of this object.
inherited

Operators

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

Static Methods

connect(Uri url, {Iterable<String>? protocols}) Future<BrowserWebSocket>
Create a new WebSocket connection using the JavaScript WebSocket API.
override