org.polkadot.rpc.provider.ws

Class WsProvider

java.lang.Object

org.polkadot.rpc.provider.ws.WsProvider

All Implemented Interfaces:

IProvider, IWsProvider

public class WsProvider
extends java.lang.Object
implements IWsProvider

@polkadot/rpc-provider/ws

WsProviderDir

The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. Unlike the HttpProvider, it does support subscriptions and allows listening to events such as new blocks or balance changes. Example

import org.polkadot.rpc.provider.ws.WsProviderDir;
WsProviderDir provider = new WsProviderDir('ws://127.0.0.1:9944');

See Also:

HttpProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WsProvider.WsStateAwaiting<T>

Nested classes/interfaces inherited from interface org.polkadot.rpc.provider.IProvider

IProvider.CallbackHandler<T,U>, IProvider.ProviderInterfaceEmitCb, IProvider.ProviderInterfaceEmitted, IProvider.SubscriptionHandler

Constructor Summary

Constructors

Constructor and Description
WsProvider()
WsProvider(java.lang.String endpoint)
WsProvider(java.lang.String endpoint, boolean autoConnect)

Method Summary

Modifier and Type	Method and Description
IProvider	clone() Returns a clone of the object
void	connect() Manually connect The WsProviderDir connects automatically by default, however if you decided otherwise, you may connect manually using this method.
void	disconnect() Manually disconnect from the connection, clearing autoconnect logic
RpcCoder	getCoder()
java.lang.String	getEndpoint()
java.util.Queue<java.lang.String>	getQueued()
java.util.Map<java.lang.String,Types.JsonRpcResponse>	getWaitingForId()
WebSocket	getWebSocket()
boolean	isAutoConnect()
boolean	isConnected()
boolean	isHasSubscriptions() true when this provider supports subscriptions
void	on(IProvider.ProviderInterfaceEmitted emitted, EventEmitter.EventListener cb)
<any>	send(java.lang.String method, java.util.List<java.lang.Object> params, IProvider.SubscriptionHandler subscription)
void	setAutoConnect(boolean autoConnect)
void	setCoder(RpcCoder coder)
void	setConnected(boolean connected)
void	setEndpoint(java.lang.String endpoint)
void	setQueued(java.util.LinkedList<java.lang.String> queued)
void	setWaitingForId(java.util.Map<java.lang.String,Types.JsonRpcResponse> waitingForId)
void	setWebSocket(WebSocketClient webSocket)
<any>	subscribe(java.lang.String type, java.lang.String method, java.util.List<java.lang.Object> params, IProvider.CallbackHandler cb)
<any>	unsubscribe(java.lang.String type, java.lang.String method, int id) Allows unsubscribing to subscriptions made with subscribe.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WsProvider

public WsProvider()

WsProvider

public WsProvider(java.lang.String endpoint)

Parameters:

endpoint - The endpoint url. Usually ws://ip:9944 or wss://ip:9944

WsProvider

public WsProvider(java.lang.String endpoint,
                  boolean autoConnect)

Parameters:

endpoint - The endpoint url. Usually ws://ip:9944 or wss://ip:9944

autoConnect - Whether to connect automatically or not.

Method Detail

connect

public void connect()

Manually connect The WsProviderDir connects automatically by default, however if you decided otherwise, you may connect manually using this method.

Specified by:

connect in interface IWsProvider

send

public <any> send(java.lang.String method,
                  java.util.List<java.lang.Object> params,
                  IProvider.SubscriptionHandler subscription)

Specified by:

send in interface IProvider

Parameters:

method - The RPC methods to execute

params - Encoded paramaters as appliucable for the method

subscription - Subscription details (internally used) Send JSON data using WebSockets to configured HTTP Endpoint or queue.

isHasSubscriptions

public boolean isHasSubscriptions()

true when this provider supports subscriptions

Specified by:

isHasSubscriptions in interface IProvider

clone

public IProvider clone()

Returns a clone of the object

Specified by:

clone in interface IProvider

Overrides:

clone in class java.lang.Object

disconnect

public void disconnect()

Manually disconnect from the connection, clearing autoconnect logic

Specified by:

disconnect in interface IProvider

isConnected

public boolean isConnected()

Specified by:

isConnected in interface IProvider

Returns:

true if connected Whether the node is connected or not.

on

public void on(IProvider.ProviderInterfaceEmitted emitted,
               EventEmitter.EventListener cb)

Specified by:

on in interface IProvider

Parameters:

{ProviderInterface$Emitted} - type Event

{ProviderInterface$EmitCb} - sub Callback Listens on events after having subscribed using the subscribe function.

subscribe

public <any> subscribe(java.lang.String type,
                       java.lang.String method,
                       java.util.List<java.lang.Object> params,
                       IProvider.CallbackHandler cb)

Specified by:

subscribe in interface IProvider

Parameters:

{string} - type Subscription type

{string} - method Subscription method

{Array} - params Parameters

{ProviderInterface$Callback} - callback Callback

Returns:

{Promise} Promise resolving to the dd of the subscription you can use with unsubscribe. subscribe Allows subscribing to a specific event. Example

WsProviderDir provider = new WsProviderDir("ws://127.0.0.1:9944");
Rpc rpc = new Rpc(provider);
rpc.state.subscribeStorage(storage.balances.freeBalance, <Address>, (_, values) => {
System.out.println(values)
}).then((subscriptionId) => {
System.out.print("balance changes subscription id: ")
System.out.println(subscriptionId)
})

unsubscribe

public <any> unsubscribe(java.lang.String type,
                         java.lang.String method,
                         int id)

Allows unsubscribing to subscriptions made with subscribe.

Specified by:

unsubscribe in interface IProvider

setConnected

public void setConnected(boolean connected)

isAutoConnect

public boolean isAutoConnect()

setAutoConnect

public void setAutoConnect(boolean autoConnect)

getCoder

public RpcCoder getCoder()

setCoder

public void setCoder(RpcCoder coder)

getEndpoint

public java.lang.String getEndpoint()

setEndpoint

public void setEndpoint(java.lang.String endpoint)

getQueued

public java.util.Queue<java.lang.String> getQueued()

setQueued

public void setQueued(java.util.LinkedList<java.lang.String> queued)

getWaitingForId

public java.util.Map<java.lang.String,Types.JsonRpcResponse> getWaitingForId()

setWaitingForId

public void setWaitingForId(java.util.Map<java.lang.String,Types.JsonRpcResponse> waitingForId)

getWebSocket

public WebSocket getWebSocket()

setWebSocket

public void setWebSocket(WebSocketClient webSocket)