mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
deploy: 1d42c4f6de
This commit is contained in:
bthomee
@@ -81,70 +81,51 @@ $(document).ready(function() { init_codefold(0); });
|
||||
<div class="headertitle"><div class="title">AbstractClient.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//------------------------------------------------------------------------------</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2016 Ripple Labs Inc.</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef XRPL_TEST_ABSTRACTCLIENT_H_INCLUDED</span></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define XRPL_TEST_ABSTRACTCLIENT_H_INCLUDED</span></div>
|
||||
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_TEST_ABSTRACTCLIENT_H_INCLUDED</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TEST_ABSTRACTCLIENT_H_INCLUDED</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <xrpl/json/json_value.h></span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span>test {</div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">/* Abstract Ripple Client interface.</span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> This abstracts the transport layer, allowing</span></div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> commands to be submitted to a rippled server.</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">*/</span></div>
|
||||
<div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html"> 14</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a38e2e35183e342c84a332666f30574ee"> 17</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a38e2e35183e342c84a332666f30574ee">~AbstractClient</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a3721f0d6e504c6ffba3a1284992fceb3"> 18</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a3721f0d6e504c6ffba3a1284992fceb3">AbstractClient</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a0ef1cce9e75ab4bc69c7a2a31521704c"> 19</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a0ef1cce9e75ab4bc69c7a2a31521704c">AbstractClient</a>(<a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a>&</div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#aa246097b1dcc906182ff2eb2d09bc7cb"> 21</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#aa246097b1dcc906182ff2eb2d09bc7cb">operator=</a>(<a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <xrpl/json/json_value.h></span></div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">namespace </span>test {</div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">/* Abstract Ripple Client interface.</span></div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> This abstracts the transport layer, allowing</span></div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> commands to be submitted to a rippled server.</span></div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">*/</span></div>
|
||||
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html"> 33</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a></div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>{</div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a38e2e35183e342c84a332666f30574ee"> 36</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a38e2e35183e342c84a332666f30574ee">~AbstractClient</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a3721f0d6e504c6ffba3a1284992fceb3"> 37</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a3721f0d6e504c6ffba3a1284992fceb3">AbstractClient</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a0ef1cce9e75ab4bc69c7a2a31521704c"> 38</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a0ef1cce9e75ab4bc69c7a2a31521704c">AbstractClient</a>(<a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a>&</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#aa246097b1dcc906182ff2eb2d09bc7cb"> 40</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#aa246097b1dcc906182ff2eb2d09bc7cb">operator=</a>(<a class="code hl_class" href="classripple_1_1test_1_1AbstractClient.html">AbstractClient</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a48e55a0ee80a76c782d40f1d055f0d55"> 54</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a48e55a0ee80a76c782d40f1d055f0d55">invoke</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& cmd, <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>& params = {}) = 0;</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span></div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a3245f799f5c542b353b61b94292d6ad9"> 58</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a3245f799f5c542b353b61b94292d6ad9">version</a>() <span class="keyword">const</span> = 0;</div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>};</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a48e55a0ee80a76c782d40f1d055f0d55"> 35</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a48e55a0ee80a76c782d40f1d055f0d55">invoke</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& cmd, <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>& params = {}) = 0;</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span></div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1AbstractClient.html#a3245f799f5c542b353b61b94292d6ad9"> 39</a></span> <a class="code hl_function" href="classripple_1_1test_1_1AbstractClient.html#a3245f799f5c542b353b61b94292d6ad9">version</a>() <span class="keyword">const</span> = 0;</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>} <span class="comment">// namespace test</span></div>
|
||||
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>} <span class="comment">// namespace ripple</span></div>
|
||||
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
|
||||
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>} <span class="comment">// namespace test</span></div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>} <span class="comment">// namespace ripple</span></div>
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
|
||||
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00148">json_value.h:149</a></div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html">ripple::test::AbstractClient</a></div><div class="ttdef"><b>Definition</b> <a href="AbstractClient_8h_source.html#l00033">AbstractClient.h:34</a></div></div>
|
||||
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00129">json_value.h:130</a></div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html">ripple::test::AbstractClient</a></div><div class="ttdef"><b>Definition</b> <a href="AbstractClient_8h_source.html#l00014">AbstractClient.h:15</a></div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html_a0ef1cce9e75ab4bc69c7a2a31521704c"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html#a0ef1cce9e75ab4bc69c7a2a31521704c">ripple::test::AbstractClient::AbstractClient</a></div><div class="ttdeci">AbstractClient(AbstractClient const &)=delete</div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html_a3245f799f5c542b353b61b94292d6ad9"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html#a3245f799f5c542b353b61b94292d6ad9">ripple::test::AbstractClient::version</a></div><div class="ttdeci">virtual unsigned version() const =0</div><div class="ttdoc">Get RPC 1.0 or RPC 2.0.</div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html_a3721f0d6e504c6ffba3a1284992fceb3"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html#a3721f0d6e504c6ffba3a1284992fceb3">ripple::test::AbstractClient::AbstractClient</a></div><div class="ttdeci">AbstractClient()=default</div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html_a38e2e35183e342c84a332666f30574ee"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html#a38e2e35183e342c84a332666f30574ee">ripple::test::AbstractClient::~AbstractClient</a></div><div class="ttdeci">virtual ~AbstractClient()=default</div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html_a48e55a0ee80a76c782d40f1d055f0d55"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html#a48e55a0ee80a76c782d40f1d055f0d55">ripple::test::AbstractClient::invoke</a></div><div class="ttdeci">virtual Json::Value invoke(std::string const &cmd, Json::Value const &params={})=0</div><div class="ttdoc">Submit a command synchronously.</div></div>
|
||||
<div class="ttc" id="aclassripple_1_1test_1_1AbstractClient_html_aa246097b1dcc906182ff2eb2d09bc7cb"><div class="ttname"><a href="classripple_1_1test_1_1AbstractClient.html#aa246097b1dcc906182ff2eb2d09bc7cb">ripple::test::AbstractClient::operator=</a></div><div class="ttdeci">AbstractClient & operator=(AbstractClient const &)=delete</div></div>
|
||||
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user