admin_startWS: WebSocket based JSON RPC API initialization.

Description Usage Arguments Value See Also Examples

View source: R/admin.R

Description

admin_startWS starts a WebSocket based JSON RPC API webserver to handle client requests.

Usage

1
2
admin_startWS(host = "127.0.0.1", port = 8546, cors = "",
  apis = "eth,net,web3")

Arguments

host

String - Network interface to open the listener socket on.

port

Integer - Network port to open the listener socket on.

cors

String - Cross-origin resource sharing header to use.

apis

String - API modules to offer over this interface.

Value

Boolean - true the execution was successful.

See Also

Other admin functions: admin_addPeer, admin_datadir, admin_nodeInfo, admin_peers, admin_setSolc, admin_startRPC, admin_stopRPC, admin_stopWS, gethr

Examples

1
2
3
admin_startWS()
admin_startWS('193.23.92.1', 8999, '*', 'eth,net,web3,personal,shh,
miner,txpool,admin,debug')

gethr documentation built on May 2, 2019, 7:03 a.m.