interface library

Classes

IWebSocketClient Client
WebSocket client interface.
WebSocketClientFake Testing
Fake WebSocket client for testing purposes.
WebSocketClientState Client Entity
WebSocket client state.
WebSocketClientState$Closed Client Entity
Connection is closed temporarily or permanently. WebSocket client state.
WebSocketClientState$Connecting Client Entity
Connection has not yet been established. WebSocket client state.
WebSocketClientState$Disconnecting Client Entity
Connection is in the process of closing. WebSocket client state.
WebSocketClientState$Open Client Entity
Connection is open and ready to communicate. WebSocket client state.
WebSocketMessagesStream Client Entity
Stream of message events handled by this WebSocket.
WebSocketMetrics Client Entity
WebSocket metrics.
WebSocketOptions Client Entity Options
Common options for VM and JS platforms:
WebSocketStatesStream Client Entity
Stream of WebSocket's WebSocketClientState changes.

Enums

WebSocketReadyState Client Entity
The IWebSocketPlatformTransport.readyState property returns the current state of the WebSocket connection.
WebSocketStatusCodes Client Entity
Endpoints MAY use the following pre-defined status codes when sending a Close frame. Web API RFC 6455, Section 7.4.1

Typedefs

ConnectionRetryInterval = ({Duration max, Duration min}) Client Entity Options
Backoff full jitter strategy for reconnecting. Tweaks for reconnect backoff algorithm (min delay, max delay)

Exceptions / Errors

WSClientClosedException Client Entity
Exception thrown when a WebSocket client is closed.
WSDisconnectException Client Entity
Disconnect operation failed.
WSException Client Entity
This is a custom exception class for WebSocket. Do not confuse it with a native exception WebSocketException from dart:io
WSNotConnectedException Client Entity
Exception thrown when a WebSocket is not connected.
WSSendException Client Entity
Send operation failed.