WebsocketConnection mixin

Websocket Connection

The Websocket JSON RPC method calls.

Mixin applications

Properties

commitment Commitment?
The default commitment level applied to all methods that query bank state.
no setter
debugNotifiers Map<SubscriptionId, WebsocketNotifier>
Returns a copy of the notification dispatchers - debugging only.
no setter
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
websocketClient JsonRpcWebsocketClient
Websocket client.
no setter
websocketClientConfig JsonRpcClientConfig?
Websocket client request configurations.
no setter

Methods

accountSubscribe(Pubkey pubkey, {WebsocketOnDataHandler<AccountInfo>? onData, WebsocketOnErrorHandler? onError, WebsocketOnDoneHandler? onDone, bool cancelOnError = false, Duration? timeLimit, AccountSubscribeConfig? config}) Future<WebsocketSubscription<AccountInfo>>
Subscribe to an account to receive notifications when the lamports or data for a given account pubkey changes.
accountUnsubscribe(WebsocketSubscription<AccountInfo> subscription) Future<bool>
Unsubscribes from account change notifications.
debugClose() → void
Closes all notification dispatchers - debugging only.
logsSubscribe(LogsFilter<Object> filter, {WebsocketOnDataHandler<LogsNotification>? onData, WebsocketOnErrorHandler? onError, WebsocketOnDoneHandler? onDone, bool cancelOnError = false, Duration? timeLimit, LogsSubscribeConfig? config}) Future<WebsocketSubscription<LogsNotification>>
Subscribes to transaction logging.
logsUnsubscribe(WebsocketSubscription<LogsNotification> subscription) Future<bool>
Unsubscribes from transaction logging.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onWebsocketConnect() → void
The websocket's connect handler.
onWebsocketData(dynamic data) → void
The websocket's data handler.
onWebsocketDisconnect() → void
The websocket's disconnect handler.
onWebsocketError(Object error, [StackTrace? stackTrace]) → void
The websocket's error handler.
programSubscribe(Pubkey programId, {WebsocketOnDataHandler<ProgramAccount>? onData, WebsocketOnErrorHandler? onError, WebsocketOnDoneHandler? onDone, bool cancelOnError = false, Duration? timeLimit, ProgramSubscribeConfig? config}) Future<WebsocketSubscription<ProgramAccount>>
Subscribes to a program to receive notifications when the lamports or data for an account owned by the given program changes.
programUnsubscribe(WebsocketSubscription<ProgramAccount> subscription) Future<bool>
Unsubscribes from program-owned account change notifications.
signatureSubscribe(String signature, {WebsocketOnDataHandler<SignatureNotification>? onData, WebsocketOnErrorHandler? onError, WebsocketOnDoneHandler? onDone, bool cancelOnError = true, Duration? timeLimit, SignatureSubscribeConfig? config}) Future<WebsocketSubscription<SignatureNotification>>
Subscribes to a transaction signature to receive a notification when the given transaction signature is committed.
signatureUnsubscribe(WebsocketSubscription<SignatureNotification> subscription) Future<bool>
Unsubscribes from signature confirmation notifications.
slotSubscribe(String signature, {WebsocketOnDataHandler<SlotNotification>? onData, WebsocketOnErrorHandler? onError, WebsocketOnDoneHandler? onDone, bool cancelOnError = false, Duration? timeLimit}) Future<WebsocketSubscription<SlotNotification>>
Subscribes to receive notification anytime a slot is processed by the validator.
slotUnsubscribe(WebsocketSubscription<SlotNotification> subscription) Future<bool>
Unsubscribes from slot notifications.
subscribe<T>(JsonRpcSubscribeMethod method, JsonRpcNotificationDecoder<T> decoder, {WebsocketOnDataHandler<T>? onData, WebsocketOnErrorHandler? onError, WebsocketOnDoneHandler? onDone, bool cancelOnError = false, bool autoUnsubscribes = false, Duration? timeLimit}) Future<WebsocketSubscription<T>>
Subscribes to the JSON RPC websocket notification of method.
toString() String
A string representation of this object.
inherited
unsubscribe(WebsocketSubscription subscription) Future<bool>
Cancels a websocket notification subscription and unsubscribes from the JSON RPC method if the subscription contains no more listeners.

Operators

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