Files
rippled/GRPCHandlers_8h_source.html
2025-11-19 09:01:20 -08:00

134 lines
12 KiB
HTML

<!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: GRPCHandlers.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_42b876eb66f74e25995e23a7c0222dc7.html">rpc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">GRPCHandlers.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="preprocessor">#ifndef XRPL_RPC_GRPCHANDLER_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_RPC_GRPCHANDLER_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 &lt;xrpld/rpc/Context.h&gt;</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="preprocessor">#include &lt;xrpl/proto/org/xrpl/rpc/v1/xrp_ledger.pb.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;grpcpp/grpcpp.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">/*</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * These handlers are for gRPC. They each take in a protobuf message that is</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * nested inside RPC::GRPCContext&lt;T&gt;, where T is the request type</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * The return value is the response type, as well as a status</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * If the status is not Status::OK (meaning an error occurred), then only</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * the status will be sent to the client, and the response will be ommitted</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><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;org::xrpl::rpc::v1::GetLedgerResponse, grpc::Status&gt;</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><a class="code hl_function" href="namespaceripple.html#a82ca6b1deeb34acfc5b0b4159b393786">doLedgerGrpc</a>(RPC::GRPCContext&lt;org::xrpl::rpc::v1::GetLedgerRequest&gt;&amp; context);</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><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;org::xrpl::rpc::v1::GetLedgerEntryResponse, grpc::Status&gt;</a></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><a class="code hl_function" href="namespaceripple.html#a8bbd46fdc8783ec29538b3d4a2e8178f">doLedgerEntryGrpc</a>(</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> RPC::GRPCContext&lt;org::xrpl::rpc::v1::GetLedgerEntryRequest&gt;&amp; context);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status&gt;</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><a class="code hl_function" href="namespaceripple.html#af3192f02f7c3e68a904df994498c955d">doLedgerDataGrpc</a>(</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> RPC::GRPCContext&lt;org::xrpl::rpc::v1::GetLedgerDataRequest&gt;&amp; context);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;org::xrpl::rpc::v1::GetLedgerDiffResponse, grpc::Status&gt;</a></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><a class="code hl_function" href="namespaceripple.html#aeaa95680c026e10fbdfbbb02300f89b8">doLedgerDiffGrpc</a>(</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> RPC::GRPCContext&lt;org::xrpl::rpc::v1::GetLedgerDiffRequest&gt;&amp; context);</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="comment">// namespace ripple</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#endif</span></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 class="ttc" id="anamespaceripple_html_a82ca6b1deeb34acfc5b0b4159b393786"><div class="ttname"><a href="namespaceripple.html#a82ca6b1deeb34acfc5b0b4159b393786">ripple::doLedgerGrpc</a></div><div class="ttdeci">std::pair&lt; org::xrpl::rpc::v1::GetLedgerResponse, grpc::Status &gt; doLedgerGrpc(RPC::GRPCContext&lt; org::xrpl::rpc::v1::GetLedgerRequest &gt; &amp;context)</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8cpp_source.html#l00081">LedgerHandler.cpp:81</a></div></div>
<div class="ttc" id="anamespaceripple_html_a8bbd46fdc8783ec29538b3d4a2e8178f"><div class="ttname"><a href="namespaceripple.html#a8bbd46fdc8783ec29538b3d4a2e8178f">ripple::doLedgerEntryGrpc</a></div><div class="ttdeci">std::pair&lt; org::xrpl::rpc::v1::GetLedgerEntryResponse, grpc::Status &gt; doLedgerEntryGrpc(RPC::GRPCContext&lt; org::xrpl::rpc::v1::GetLedgerEntryRequest &gt; &amp;context)</div><div class="ttdef"><b>Definition</b> <a href="LedgerEntry_8cpp_source.html#l00832">LedgerEntry.cpp:832</a></div></div>
<div class="ttc" id="anamespaceripple_html_aeaa95680c026e10fbdfbbb02300f89b8"><div class="ttname"><a href="namespaceripple.html#aeaa95680c026e10fbdfbbb02300f89b8">ripple::doLedgerDiffGrpc</a></div><div class="ttdeci">std::pair&lt; org::xrpl::rpc::v1::GetLedgerDiffResponse, grpc::Status &gt; doLedgerDiffGrpc(RPC::GRPCContext&lt; org::xrpl::rpc::v1::GetLedgerDiffRequest &gt; &amp;context)</div><div class="ttdef"><b>Definition</b> <a href="LedgerDiff_8cpp_source.html#l00006">LedgerDiff.cpp:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_af3192f02f7c3e68a904df994498c955d"><div class="ttname"><a href="namespaceripple.html#af3192f02f7c3e68a904df994498c955d">ripple::doLedgerDataGrpc</a></div><div class="ttdeci">std::pair&lt; org::xrpl::rpc::v1::GetLedgerDataResponse, grpc::Status &gt; doLedgerDataGrpc(RPC::GRPCContext&lt; org::xrpl::rpc::v1::GetLedgerDataRequest &gt; &amp;context)</div><div class="ttdef"><b>Definition</b> <a href="LedgerData_8cpp_source.html#l00118">LedgerData.cpp:118</a></div></div>
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>
</div><!-- fragment --></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>