SockJSClient class

A SockJS Client that acts and looks like a browser WebSocket object.

See https://github.com/sockjs/sockjs-client for more information on SockJS in general.

All of the SockJS implementation logic lives in the native SockJS library. This SockJSClient class is simply a wrapper that provides a typed API accessible from Dart.

Constructors

SockJSClient(Uri uri, {SockJSOptions? options})
Constructs a new SockJSClient that will attempt to connect to a SockJS server at the given uri.

Properties

didDispose → Future<Null>
A Future that will complete when this object has been disposed.
no setterinherited
disposableTypeName → String
A type name, similar to runtimeType but intended to work with minified code.
no setter
disposalTreeSize → int
The total size of the disposal tree rooted at the current Disposable instance.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isDisposed → bool
Whether this object has been disposed.
no setterinherited
isLeakFlagSet → bool
Whether the leak flag for this object has been set.
no setterinherited
isOrWillBeDisposed → bool
Whether the disposal of this object has been requested, is in progress, or is complete.
no setterinherited
onClose → Stream<SockJSCloseEvent>
A stream that can be listened to in order to know when this SockJS Client has closed.
no setter
onMessage → Stream<SockJSMessageEvent>
A stream of message events received from the server.
no setter
onOpen → Stream<SockJSOpenEvent>
A stream that can be listened to in order to know when this SockJS Client has successfully connected to the server.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

awaitBeforeDispose<T>(Future<T> future) → Future<T>
Add future to a list of futures that will be awaited before the object is disposed.
inherited
close([int? closeCode, String? reason]) → void
Close this client.
dispose() → Future<Null>
Dispose of the object, cleaning up to prevent memory leaks.
inherited
flagLeak([String? description]) → void
Flag the object as having been disposed in a way that allows easier profiling.
inherited
getManagedDelayedFuture<T>(Duration duration, T callback()) → Future<T>
Creates a Future that will complete, with the value returned by callback, after the given amount of time has elapsed.
inherited
getManagedDisposer(Disposer disposer) → ManagedDisposer
Automatically handle arbitrary disposals using a callback.
inherited
getManagedPeriodicTimer(Duration duration, void callback(Timer timer)) → Timer
Creates a periodic Timer that will be cancelled if active upon disposal.
inherited
getManagedTimer(Duration duration, void callback()) → Timer
Creates a Timer instance that will be cancelled if active upon disposal.
inherited
listenToStream<T>(Stream<T> stream, void onData(T event), {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<T>
Returns a StreamSubscription which handles events from the stream using the provided onData, onError and onDone handlers.
inherited
manageAndReturnTypedDisposable<T extends Disposable>(T disposable) → T
Automatically dispose another object when this object is disposed.
inherited
manageCompleter<T>(Completer<T> completer) → Completer<T>
Ensure that a completer is completed when the object is disposed.
inherited
manageDisposable(Disposable disposable) → void
inherited
manageStreamController(StreamController controller) → void
Automatically cancel a stream controller when this object is disposed.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDispose() → Future<Null>
Callback to allow arbitrary cleanup on dispose.
inherited
onWillDispose() → Future<Null>
Callback to allow arbitrary cleanup as soon as disposal is requested (i.e. dispose is called) but prior to disposal actually starting.
send(String data) → void
Send data to the server.
subscribeToDocumentEvent(String event, EventListener callback, {bool? useCapture, EventTarget? documentObject}) → void
Adds an event listener to the document object and removes the event listener upon disposal.
inherited
subscribeToDomElementEvent(Element element, String event, EventListener callback, {bool? useCapture}) → void
Adds an event listener to the element object and removes the event listener upon disposal.
inherited
subscribeToWindowEvent(String event, EventListener callback, {bool? useCapture, EventTarget? windowObject}) → void
Adds an event listener to the window object and removes the event listener upon disposal.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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