xrpl_websocket package¶
Submodules¶
xrpl_websocket.client module¶
-
class
xrpl_websocket.client.
Client
(server=None, timeout=None, log_level=None, *args, **kwargs)¶ Bases:
threading.Thread
Higher level of APIs are provided. The interface is like JavaScript WebSocket object.
-
__init__
(server=None, timeout=None, log_level=None, *args, **kwargs)¶ Parameters: - server – rippled node url.
- timeout – connection timeout seconds
- log_level – loggin level
- on_open – callable object which is called at opening websocket.
- on_reconnect – callable object which is called at reconnecting
- on_error – callable object which is called when we get error.
- on_close – callable object which is called when closed the connection.
- on_transaction – callback object which is called when we recieve transacion
- on_ledger – callback object which is called when we recieve ledger close
- on_validation – callback object by the validations stream when the server receives a validation message
- on_manifest – callback object sent by the manifests stream when the server receives a manifest.
-
connect
(nowait=True)¶ Simulate self.start(), run the main thread
Returns:
-
disconnect
()¶ Disconnects from the websocket connection and joins the Thread.
Returns:
-
reconnect
()¶ Issues a reconnection by setting the reconnect_required event.
Returns:
-
run
()¶ Main method of Thread.
Returns:
-
send
(payload=None, **kwargs)¶ Sends the given Payload to the API via the websocket connection.
Parameters: - payload –
- kwargs – payload parameters as key=value pairs
Returns:
-
send_ping
()¶ Sends a ping message to the API and starts pong timers.
Returns:
-
xrpl_websocket.exceptions module¶
-
exception
xrpl_websocket.exceptions.
ConnectionError
(message, data)¶
-
exception
xrpl_websocket.exceptions.
DisconnectedError
(message, data)¶
-
exception
xrpl_websocket.exceptions.
Error
(message, data)¶ Bases:
Exception
-
exception
xrpl_websocket.exceptions.
NotConnectedError
(message, data)¶
-
exception
xrpl_websocket.exceptions.
ResponseFormatError
(message, data)¶
-
exception
xrpl_websocket.exceptions.
TimeoutError
(message, data)¶
-
exception
xrpl_websocket.exceptions.
UnexpectedError
(message, data)¶