rippled
Public Member Functions | List of all members
ripple::test::WSClient Class Referenceabstract
Inheritance diagram for ripple::test::WSClient:
Inheritance graph
[legend]
Collaboration diagram for ripple::test::WSClient:
Collaboration graph
[legend]

Public Member Functions

virtual std::optional< Json::ValuegetMsg (std::chrono::milliseconds const &timeout=std::chrono::milliseconds{ 0})=0
 Retrieve a message. More...
 
virtual std::optional< Json::ValuefindMsg (std::chrono::milliseconds const &timeout, std::function< bool(Json::Value const &)> pred)=0
 Retrieve a message that meets the predicate criteria. More...
 
virtual Json::Value invoke (std::string const &cmd, Json::Value const &params={})=0
 Submit a command synchronously. More...
 
virtual unsigned version () const =0
 Get RPC 1.0 or RPC 2.0. More...
 

Detailed Description

Definition at line 33 of file WSClient.h.

Member Function Documentation

◆ getMsg()

virtual std::optional<Json::Value> ripple::test::WSClient::getMsg ( std::chrono::milliseconds const &  timeout = std::chrono::milliseconds{ 0})
pure virtual

Retrieve a message.

Implemented in ripple::test::WSClientImpl.

◆ findMsg()

virtual std::optional<Json::Value> ripple::test::WSClient::findMsg ( std::chrono::milliseconds const &  timeout,
std::function< bool(Json::Value const &)>  pred 
)
pure virtual

Retrieve a message that meets the predicate criteria.

Implemented in ripple::test::WSClientImpl.

◆ invoke()

virtual Json::Value ripple::test::AbstractClient::invoke ( std::string const &  cmd,
Json::Value const &  params = {} 
)
pure virtualinherited

Submit a command synchronously.

The arguments to the function and the returned JSON are in a normalized format, the same whether the client is using the JSON-RPC over HTTP/S or WebSocket transport.

Parameters
cmdThe command to execute
paramsJson::Value of null or object type with zero or more key/value pairs.
Returns
The server response in normalized format.

Implemented in ripple::test::WSClientImpl, and ripple::test::JSONRPCClient.

◆ version()

virtual unsigned ripple::test::AbstractClient::version ( ) const
pure virtualinherited

Get RPC 1.0 or RPC 2.0.

Implemented in ripple::test::WSClientImpl, and ripple::test::JSONRPCClient.