WebSocketProtocol class

Inheritance

Constructors

WebSocketProtocol(Uri uri, {bool autoReconnect = true, Duration reconnectionDelay = const Duration(seconds: 1), int reconnectionAttempts = 10, Duration pingInterval = const Duration(seconds: 2)})

Properties

abortConnection ↔ bool
getter/setter pairinherited
autoReconnect ↔ bool
getter/setter pairinherited
connectionAborted → bool
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
finalinherited
pingInterval ↔ Duration
getter/setter pairinherited
protocolState ↔ KuzzleProtocolState
getter/setter pairinherited
reconnectionAttempts ↔ int
getter/setter pairinherited
reconnectionDelay ↔ Duration
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → KuzzleProtocolState
no setterinherited
uri → Uri
finalinherited

Methods

addListener(String eventName, Function callback, {bool once = false}) → void
inherited
clientDisconnected() → void
Called when the client's connection is closed
inherited
clientNetworkError([dynamic error]) → void
Called when the client's connection is closed with an error state
inherited
close() → void
Called when the client's connection is closed
inherited
connect() → Future<void>
inherited
emit(String eventName, [List? positionalArguments, Map<Symbol, dynamic>? namedArguments]) → bool
Call all listeners registered for eventName event
inherited
eventNames() → List<String>
inherited
isReady() → bool
inherited
listenerCount(String eventName) → int
inherited
listeners(String eventName) → List<_KuzzleListener>?
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off(String eventName, Function callback) → void
inherited
on(String eventName, Function callback) → void
inherited
once(String eventName, Function callback) → void
inherited
prependListener(String eventName, Function callback, {bool once = false}) → void
inherited
protocolConnect() → Future<void>
inherited
query(KuzzleRequest request) → Future<KuzzleResponse>
Register a response event handler for request
inherited
removeAllListeners([String? eventName]) → void
inherited
removeListener(String eventName, Function callback) → void
inherited
send(KuzzleRequest request) → Future<void>
Sends a payload to the connected server
inherited
toString() → String
A string representation of this object.
inherited

Operators

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