KletsoSocket class abstract interface

One attached realtime session. Produced by KletsoTransport.open only after the server acknowledged authentication, so readySeq is always known.

Properties

audio → Stream<KletsoAudioFrame>
Audio frames from the server (assistant speech). Empty when supportsBinary is false. Closes with frames.
no setter
done → Future<KletsoCloseInfo>
Completes when the socket has ended, however that happened.
no setter
frames → Stream<KletsoServerFrame>
Frames from the server, in order. The stream closes when the socket ends, and it must close before done completes so consumers can drain buffered frames (KletsoConnection relies on this).
no setter
hashCode → int
The hash code for this object.
no setterinherited
readySeq → int
The seq the server reported as current when it accepted the client.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
supportsBinary → bool
Whether this socket can carry voice audio (binary frames, D79). SSE cannot; the WebSocket and fake transports can.
no setter

Methods

close([int code = KletsoCloseCodes.normal, String reason = '']) → Future<void>
Closes the socket; code follows WebSocket semantics.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
send(KletsoClientFrame frame) → Future<void>
Sends one frame. Throws KletsoNetworkException when the socket is no longer usable.
sendAudio(KletsoAudioFrame frame) → Future<void>
Sends microphone audio. Throws KletsoNetworkException when the socket cannot carry binary frames or is closed.
toString() → String
A string representation of this object.
inherited

Operators

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