ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1test_1_1WSClient.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

281 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::test::WSClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1test.html">test</a></li><li class="navelem"><a class="el" href="classripple_1_1test_1_1WSClient.html">WSClient</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1test_1_1WSClient-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::WSClient Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="WSClient_8h_source.html">WSClient.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::test::WSClient:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1test_1_1WSClient__inherit__graph.png" border="0" usemap="#aripple_1_1test_1_1WSClient_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1test_1_1WSClient_inherit__map" id="aripple_1_1test_1_1WSClient_inherit__map">
<area shape="rect" title=" " alt="" coords="22,79,181,104"/>
<area shape="rect" href="classripple_1_1test_1_1WSClientImpl.html" title=" " alt="" coords="7,152,195,177"/>
<area shape="poly" title=" " alt="" coords="104,118,104,152,99,152,99,118"/>
<area shape="rect" href="classripple_1_1test_1_1AbstractClient.html" title=" " alt="" coords="5,5,197,31"/>
<area shape="poly" title=" " alt="" coords="104,44,104,79,99,79,99,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::test::WSClient:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1test_1_1WSClient__coll__graph.png" border="0" usemap="#aripple_1_1test_1_1WSClient_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1test_1_1WSClient_coll__map" id="aripple_1_1test_1_1WSClient_coll__map">
<area shape="rect" title=" " alt="" coords="22,79,181,104"/>
<area shape="rect" href="classripple_1_1test_1_1AbstractClient.html" title=" " alt="" coords="5,5,197,31"/>
<area shape="poly" title=" " alt="" coords="104,44,104,79,99,79,99,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a50d447299a0ea869f3d6130cc1d304d8" id="r_a50d447299a0ea869f3d6130cc1d304d8"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classJson_1_1Value.html">Json::Value</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1WSClient.html#a50d447299a0ea869f3d6130cc1d304d8">getMsg</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> const &amp;timeout=<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a>{ 0})=0</td></tr>
<tr class="memdesc:a50d447299a0ea869f3d6130cc1d304d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a message. <br /></td></tr>
<tr class="separator:a50d447299a0ea869f3d6130cc1d304d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac72a2c0ab4d2a5cb0f9cd288a887df8c" id="r_ac72a2c0ab4d2a5cb0f9cd288a887df8c"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classJson_1_1Value.html">Json::Value</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1WSClient.html#ac72a2c0ab4d2a5cb0f9cd288a887df8c">findMsg</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> const &amp;timeout, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; bool(<a class="el" href="classJson_1_1Value.html">Json::Value</a> const &amp;)&gt; pred)=0</td></tr>
<tr class="memdesc:ac72a2c0ab4d2a5cb0f9cd288a887df8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a message that meets the predicate criteria. <br /></td></tr>
<tr class="separator:ac72a2c0ab4d2a5cb0f9cd288a887df8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48e55a0ee80a76c782d40f1d055f0d55" id="r_a48e55a0ee80a76c782d40f1d055f0d55"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classJson_1_1Value.html">Json::Value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1AbstractClient.html#a48e55a0ee80a76c782d40f1d055f0d55">invoke</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;cmd, <a class="el" href="classJson_1_1Value.html">Json::Value</a> const &amp;params={})=0</td></tr>
<tr class="memdesc:a48e55a0ee80a76c782d40f1d055f0d55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit a command synchronously. <br /></td></tr>
<tr class="separator:a48e55a0ee80a76c782d40f1d055f0d55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3245f799f5c542b353b61b94292d6ad9" id="r_a3245f799f5c542b353b61b94292d6ad9"><td class="memItemLeft" align="right" valign="top">virtual unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1AbstractClient.html#a3245f799f5c542b353b61b94292d6ad9">version</a> () const =0</td></tr>
<tr class="memdesc:a3245f799f5c542b353b61b94292d6ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get <a class="el" href="namespaceripple_1_1RPC.html" title="API version numbers used in later API versions.">RPC</a> 1.0 or <a class="el" href="namespaceripple_1_1RPC.html" title="API version numbers used in later API versions.">RPC</a> 2.0. <br /></td></tr>
<tr class="separator:a3245f799f5c542b353b61b94292d6ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="WSClient_8h_source.html#l00015">15</a> of file <a class="el" href="WSClient_8h_source.html">WSClient.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a50d447299a0ea869f3d6130cc1d304d8" name="a50d447299a0ea869f3d6130cc1d304d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50d447299a0ea869f3d6130cc1d304d8">&#9670;&#160;</a></span>getMsg()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classJson_1_1Value.html">Json::Value</a> &gt; ripple::test::WSClient::getMsg </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> const &amp;&#160;</td>
<td class="paramname"><em>timeout</em> = <code><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a>{&#160;0}</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a message. </p>
<p>Implemented in <a class="el" href="classripple_1_1test_1_1WSClientImpl.html#a3d055137a12f5fab28bc0b0bdbfbb9dd">ripple::test::WSClientImpl</a>.</p>
</div>
</div>
<a id="ac72a2c0ab4d2a5cb0f9cd288a887df8c" name="ac72a2c0ab4d2a5cb0f9cd288a887df8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac72a2c0ab4d2a5cb0f9cd288a887df8c">&#9670;&#160;</a></span>findMsg()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classJson_1_1Value.html">Json::Value</a> &gt; ripple::test::WSClient::findMsg </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> const &amp;&#160;</td>
<td class="paramname"><em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; bool(<a class="el" href="classJson_1_1Value.html">Json::Value</a> const &amp;)&gt;&#160;</td>
<td class="paramname"><em>pred</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a message that meets the predicate criteria. </p>
<p>Implemented in <a class="el" href="classripple_1_1test_1_1WSClientImpl.html#aff7ab6bfabd9e2256a473d18ea0fae30">ripple::test::WSClientImpl</a>.</p>
</div>
</div>
<a id="a48e55a0ee80a76c782d40f1d055f0d55" name="a48e55a0ee80a76c782d40f1d055f0d55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48e55a0ee80a76c782d40f1d055f0d55">&#9670;&#160;</a></span>invoke()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classJson_1_1Value.html">Json::Value</a> ripple::test::AbstractClient::invoke </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classJson_1_1Value.html">Json::Value</a> const &amp;&#160;</td>
<td class="paramname"><em>params</em> = <code>{}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Submit a command synchronously. </p>
<p>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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cmd</td><td>The command to execute </td></tr>
<tr><td class="paramname">params</td><td><a class="el" href="classJson_1_1Value.html" title="Represents a JSON value.">Json::Value</a> of null or object type with zero or more key/value pairs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The server response in normalized format. </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1test_1_1JSONRPCClient.html#a9875ee0122004b7a8592fa9c42c2f054">ripple::test::JSONRPCClient</a>, and <a class="el" href="classripple_1_1test_1_1WSClientImpl.html#a502eba2d2669de03da03191219c568d3">ripple::test::WSClientImpl</a>.</p>
</div>
</div>
<a id="a3245f799f5c542b353b61b94292d6ad9" name="a3245f799f5c542b353b61b94292d6ad9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3245f799f5c542b353b61b94292d6ad9">&#9670;&#160;</a></span>version()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ripple::test::AbstractClient::version </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="namespaceripple_1_1RPC.html" title="API version numbers used in later API versions.">RPC</a> 1.0 or <a class="el" href="namespaceripple_1_1RPC.html" title="API version numbers used in later API versions.">RPC</a> 2.0. </p>
<p>Implemented in <a class="el" href="classripple_1_1test_1_1JSONRPCClient.html#a3e9907c3c05d837110db13178304824f">ripple::test::JSONRPCClient</a>, and <a class="el" href="classripple_1_1test_1_1WSClientImpl.html#a1226fae22971f69cc03846503f84232f">ripple::test::WSClientImpl</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink