StreamWebSocketClient class

A WebSocket client with connection management and event handling.

The primary interface for WebSocket connections in the Stream Core SDK that provides functionality for real-time communication with automatic reconnection, health monitoring, and sophisticated state management.

Each StreamWebSocketClient instance manages its own connection lifecycle and maintains state that can be observed for real-time updates. The client handles message encoding/decoding, connection recovery, and event distribution.

Example

final client = StreamWebSocketClient(
  options: WebSocketOptions(url: 'wss://api.example.com'),
  messageCodec: JsonMessageCodec(),
  onConnectionEstablished: () {
    client.send(AuthRequest(token: authToken));
  },
);

await client.connect();

Implemented types

• WebSocketHealthListener
• WebSocketEngineListener<WsEvent>

Constructors

StreamWebSocketClient.new({required WebSocketOptions options, void onConnectionEstablished()?, WebSocketProvider? wsProvider, PingRequestBuilder pingRequestBuilder = _defaultPingRequestBuilder, required WebSocketMessageCodec<WsEvent, WsRequest> messageCodec, Iterable<EventResolver<WsEvent>>? eventResolvers})

Creates a new instance of StreamWebSocketClient.

Properties

connectionState → ConnectionStateEmitter

The current connection state of the WebSocket.

no setter

events → EventEmitter<WsEvent>

The event emitter for WebSocket events.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

onConnectionEstablished → void Function()?

Called when the WebSocket connection is established and ready for authentication.

final

options → WebSocketOptions

The WebSocket connection options including URL and configuration.

final

pingRequestBuilder → PingRequestBuilder

The function used to build ping requests for health checks.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

connect() → Future<void>

Establishes a WebSocket connection.

disconnect({CloseCode closeCode = CloseCode.normalClosure, DisconnectionSource source = const UserInitiated()}) → Future<void>

Closes the WebSocket connection.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onClose([int? closeCode, String? closeReason]) → void

Called when the WebSocket connection is closed.

override

onError(Object error, [StackTrace? stackTrace]) → void

Called when an error occurs on the WebSocket connection.

override

onMessage(WsEvent event) → void

Called when a message is received from the WebSocket.

override

onOpen() → void

Called when the WebSocket connection is successfully opened.

override

onPingRequested() → void

Called when it's time to send a ping request for health checking.

override

onUnhealthy() → void

Called when the WebSocket connection is determined to be unhealthy.

override

send(WsRequest request) → Result<void>

Sends a message through the WebSocket connection.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited