Files
rippled/structripple_1_1RPC_1_1ErrorInfo.html
2025-11-04 00:36:48 -08:00

317 lines
16 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: ripple::RPC::ErrorInfo Struct 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_1RPC.html">RPC</a></li><li class="navelem"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html">ErrorInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1RPC_1_1ErrorInfo-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RPC::ErrorInfo Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Maps an rpc error code to its token, default message, and HTTP status.
<a href="structripple_1_1RPC_1_1ErrorInfo.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::RPC::ErrorInfo:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1RPC_1_1ErrorInfo__coll__graph.png" border="0" usemap="#aripple_1_1RPC_1_1ErrorInfo_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1RPC_1_1ErrorInfo_coll__map" id="aripple_1_1RPC_1_1ErrorInfo_coll__map">
<area shape="rect" title="Maps an rpc error code to its token, default message, and HTTP status." alt="" coords="5,108,163,133"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="18,5,150,31"/>
<area shape="poly" title=" " alt="" coords="87,45,87,108,81,108,81,45"/>
</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:a47cdbe8044639c7f7caf595c32332d89" id="r_a47cdbe8044639c7f7caf595c32332d89"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html#a47cdbe8044639c7f7caf595c32332d89">ErrorInfo</a> ()</td></tr>
<tr class="separator:a47cdbe8044639c7f7caf595c32332d89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51d565c582c370606a801cca4f51812a" id="r_a51d565c582c370606a801cca4f51812a"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html#a51d565c582c370606a801cca4f51812a">ErrorInfo</a> (<a class="el" href="namespaceripple.html#a32d6d3ce1a48272b677d2c88b1d30932">error_code_i</a> code_, char const *token_, char const *message_)</td></tr>
<tr class="separator:a51d565c582c370606a801cca4f51812a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcd795113e89e9228b6904742515a9fa" id="r_adcd795113e89e9228b6904742515a9fa"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html#adcd795113e89e9228b6904742515a9fa">ErrorInfo</a> (<a class="el" href="namespaceripple.html#a32d6d3ce1a48272b677d2c88b1d30932">error_code_i</a> code_, char const *token_, char const *message_, int http_status_)</td></tr>
<tr class="separator:adcd795113e89e9228b6904742515a9fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a905f6376e2efa99d9a5b52b0b107c0e7" id="r_a905f6376e2efa99d9a5b52b0b107c0e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a32d6d3ce1a48272b677d2c88b1d30932">error_code_i</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html#a905f6376e2efa99d9a5b52b0b107c0e7">code</a></td></tr>
<tr class="separator:a905f6376e2efa99d9a5b52b0b107c0e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e9f8835d2e92985ab09e927ef569c76" id="r_a8e9f8835d2e92985ab09e927ef569c76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJson_1_1StaticString.html">Json::StaticString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html#a8e9f8835d2e92985ab09e927ef569c76">token</a></td></tr>
<tr class="separator:a8e9f8835d2e92985ab09e927ef569c76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7da2ca0fedad1eb20f8a492eebc55d67" id="r_a7da2ca0fedad1eb20f8a492eebc55d67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJson_1_1StaticString.html">Json::StaticString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html#a7da2ca0fedad1eb20f8a492eebc55d67">message</a></td></tr>
<tr class="separator:a7da2ca0fedad1eb20f8a492eebc55d67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08285f5655ec9e56b914d8d699820a93" id="r_a08285f5655ec9e56b914d8d699820a93"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1ErrorInfo.html#a08285f5655ec9e56b914d8d699820a93">http_status</a></td></tr>
<tr class="separator:a08285f5655ec9e56b914d8d699820a93"><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>Maps an rpc error code to its token, default message, and HTTP status. </p>
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00169">169</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a47cdbe8044639c7f7caf595c32332d89" name="a47cdbe8044639c7f7caf595c32332d89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47cdbe8044639c7f7caf595c32332d89">&#9670;&#160;</a></span>ErrorInfo() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr ripple::RPC::ErrorInfo::ErrorInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00172">172</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>.</p>
</div>
</div>
<a id="a51d565c582c370606a801cca4f51812a" name="a51d565c582c370606a801cca4f51812a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51d565c582c370606a801cca4f51812a">&#9670;&#160;</a></span>ErrorInfo() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr ripple::RPC::ErrorInfo::ErrorInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a32d6d3ce1a48272b677d2c88b1d30932">error_code_i</a>&#160;</td>
<td class="paramname"><em>code_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>token_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>message_</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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00180">180</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>.</p>
</div>
</div>
<a id="adcd795113e89e9228b6904742515a9fa" name="adcd795113e89e9228b6904742515a9fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcd795113e89e9228b6904742515a9fa">&#9670;&#160;</a></span>ErrorInfo() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr ripple::RPC::ErrorInfo::ErrorInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a32d6d3ce1a48272b677d2c88b1d30932">error_code_i</a>&#160;</td>
<td class="paramname"><em>code_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>token_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>message_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>http_status_</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">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00188">188</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a905f6376e2efa99d9a5b52b0b107c0e7" name="a905f6376e2efa99d9a5b52b0b107c0e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a905f6376e2efa99d9a5b52b0b107c0e7">&#9670;&#160;</a></span>code</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a32d6d3ce1a48272b677d2c88b1d30932">error_code_i</a> ripple::RPC::ErrorInfo::code</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00200">200</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>.</p>
</div>
</div>
<a id="a8e9f8835d2e92985ab09e927ef569c76" name="a8e9f8835d2e92985ab09e927ef569c76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e9f8835d2e92985ab09e927ef569c76">&#9670;&#160;</a></span>token</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJson_1_1StaticString.html">Json::StaticString</a> ripple::RPC::ErrorInfo::token</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00201">201</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>.</p>
</div>
</div>
<a id="a7da2ca0fedad1eb20f8a492eebc55d67" name="a7da2ca0fedad1eb20f8a492eebc55d67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7da2ca0fedad1eb20f8a492eebc55d67">&#9670;&#160;</a></span>message</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJson_1_1StaticString.html">Json::StaticString</a> ripple::RPC::ErrorInfo::message</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00202">202</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</a>.</p>
</div>
</div>
<a id="a08285f5655ec9e56b914d8d699820a93" name="a08285f5655ec9e56b914d8d699820a93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08285f5655ec9e56b914d8d699820a93">&#9670;&#160;</a></span>http_status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::RPC::ErrorInfo::http_status</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ErrorCodes_8h_source.html#l00203">203</a> of file <a class="el" href="ErrorCodes_8h_source.html">ErrorCodes.h</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>