One full-duplex WebSocket session.
A session is returned in AlphaXWebSocketState.open. messages is a single-subscription stream of complete text or binary messages. Consuming that stream is the receive operation; its pause/resume and cancellation behavior follows normal Dart stream semantics. done completes once with terminal close information.
Properties
-
done
→ Future<
AlphaXWebSocketCloseInfo> -
Completes once when the session is terminal.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
messages
→ Stream<
AlphaXWebSocketMessage> -
Ordered complete messages received from the peer.
no setter
- negotiatedSubprotocol → String?
-
The provider-reported negotiated subprotocol, or
nullwhen none was selected or the provider did not report one.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → AlphaXWebSocketState
-
Current lifecycle state.
no setter
Methods
-
close(
{int? code, String? reason}) → Future< void> - Starts local close with an optional valid code and reason.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
send(
AlphaXWebSocketMessage message) → Future< void> - Sends one complete message in call order.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited