joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/en/doxygen/html/rpc_2protocol_8h.html

549 lines
36 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: src/rpc/protocol.h File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('rpc_2protocol_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">protocol.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;list&gt;</code><br />
<code>#include &lt;map&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;boost/filesystem.hpp&gt;</code><br />
<code>#include &lt;<a class="el" href="univalue_8h_source.html">univalue.h</a>&gt;</code><br />
</div>
<p><a href="rpc_2protocol_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ab0a9668b7d736b4d4d621ec010928a46"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46">HTTPStatusCode</a> { <br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46a43f8027764325bbcad2f773511156d0a">HTTP_OK</a> = 200,
<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46a173b2a55d636fe537b9069a4fb3388f2">HTTP_BAD_REQUEST</a> = 400,
<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46a74677f364201a3d068bc6b9db7359288">HTTP_UNAUTHORIZED</a> = 401,
<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46a7aec6e8ecb79ff84830a69e52ff01d17">HTTP_FORBIDDEN</a> = 403,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46a7a2f2a109c030ee9d2d5afe761232451">HTTP_NOT_FOUND</a> = 404,
<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46a40d47a5f8adc6d74c1ec977528a36edf">HTTP_BAD_METHOD</a> = 405,
<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46ac7d2e49bfead01d65a890a2e80e5b3a6">HTTP_INTERNAL_SERVER_ERROR</a> = 500,
<a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46a6251d4710923e5253b159943405a1a3a">HTTP_SERVICE_UNAVAILABLE</a> = 503
<br />
}</td></tr>
<tr class="memdesc:ab0a9668b7d736b4d4d621ec010928a46"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTP status codes. <a href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46">More...</a><br /></td></tr>
<tr class="separator:ab0a9668b7d736b4d4d621ec010928a46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af867221d51315471f28ed8cdac85dead"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85dead">RPCErrorCode</a> { <br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadaf8310a778a7a84d76adde337d695fd0d">RPC_INVALID_REQUEST</a> = -32600,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada730bd898e0c5940282c275f49470a794">RPC_METHOD_NOT_FOUND</a> = -32601,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada784a3cc09b65fa47ff1d70fbd3bfbaca">RPC_INVALID_PARAMS</a> = -32602,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadad4f5ea69465f2a32fda9b9bf5e698803">RPC_INTERNAL_ERROR</a> = -32603,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada3632e7ba1deeda31ff77fe80bdaf7fe6">RPC_PARSE_ERROR</a> = -32700,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada5aa884a9e263e1fad4ad13ec564d33d5">RPC_MISC_ERROR</a> = -1,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada456d9eafa45bb1041024b834a063ea80">RPC_FORBIDDEN_BY_SAFE_MODE</a> = -2,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada7c63246a7c7bc5912d499fb117358506">RPC_TYPE_ERROR</a> = -3,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadafb8d27e000f4a668b66974c73256a576">RPC_INVALID_ADDRESS_OR_KEY</a> = -5,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada2b50733804d98a7d4f2252563d864a66">RPC_OUT_OF_MEMORY</a> = -7,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadab38a9a653209a57acfc9a551c310e4dc">RPC_INVALID_PARAMETER</a> = -8,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadadcfa95f6aca9c3a474fffac8c8ab1dd1">RPC_DATABASE_ERROR</a> = -20,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadae41723a0e8091c7853a1e582e317b272">RPC_DESERIALIZATION_ERROR</a> = -22,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadac8a991699304f068eb1d77e923b5c72f">RPC_VERIFY_ERROR</a> = -25,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadaf85dae2af118644e7aec72ffbc97c1c6">RPC_VERIFY_REJECTED</a> = -26,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada074c4989af08b8a44674cd1a7fd84be5">RPC_VERIFY_ALREADY_IN_CHAIN</a> = -27,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadab8aee859ef513c81f87aa298e8c0cf7c">RPC_IN_WARMUP</a> = -28,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadaa2bc9f33fd0ba09e486eeeeafaae968c">RPC_TRANSACTION_ERROR</a> = RPC_VERIFY_ERROR,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada9e05169dd202b16a07bc124bd6e451d5">RPC_TRANSACTION_REJECTED</a> = RPC_VERIFY_REJECTED,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada7a1b53103d599a098159e4f8171c4387">RPC_TRANSACTION_ALREADY_IN_CHAIN</a> = RPC_VERIFY_ALREADY_IN_CHAIN,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadaab5f4888435073da8cd11d99d274c8af">RPC_CLIENT_NOT_CONNECTED</a> = -9,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadadd3692758a03ba3dcd1accbdd656b27f">RPC_CLIENT_IN_INITIAL_DOWNLOAD</a> = -10,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada69beae07cb7520bde6d66c32ebde05c4">RPC_CLIENT_NODE_ALREADY_ADDED</a> = -23,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadadd603a70e2d6eb11ef5b3aad2f83fd70">RPC_CLIENT_NODE_NOT_ADDED</a> = -24,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada02613c7ff5b899411910a3d69ab3a47a">RPC_CLIENT_NODE_NOT_CONNECTED</a> = -29,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada47dd1e11bdbe307d901c99589c584b9f">RPC_CLIENT_INVALID_IP_OR_SUBNET</a> = -30,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadafec84f7fdd91f69c7d5f89a020be9f70">RPC_CLIENT_P2P_DISABLED</a> = -31,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadaba6f8682002fa223d3a405b743b5a540">RPC_WALLET_ERROR</a> = -4,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada5e46fc2ff7c51b8423b6eaf5b33ebfb9">RPC_WALLET_INSUFFICIENT_FUNDS</a> = -6,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada05642c62794bf107e9be801e76a4c89e">RPC_WALLET_INVALID_ACCOUNT_NAME</a> = -11,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadadacb2152d14607886f90ed134c94e21d">RPC_WALLET_KEYPOOL_RAN_OUT</a> = -12,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada0c1fbdf17d83da9f5124f2dbf0ba4765">RPC_WALLET_UNLOCK_NEEDED</a> = -13,
<br />
&#160;&#160;<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deadae7f578c2ec4458c79250e204505dedcc">RPC_WALLET_PASSPHRASE_INCORRECT</a> = -14,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada6aa5da515d4b7230dfeb65017b9fd38d">RPC_WALLET_WRONG_ENC_STATE</a> = -15,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada796c728d5ec3fc308609494e1d608940">RPC_WALLET_ENCRYPTION_FAILED</a> = -16,
<a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85deada13d89bf3248220d312af052959f71b0b">RPC_WALLET_ALREADY_UNLOCKED</a> = -17
<br />
}</td></tr>
<tr class="memdesc:af867221d51315471f28ed8cdac85dead"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dash Core RPC error codes. <a href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85dead">More...</a><br /></td></tr>
<tr class="separator:af867221d51315471f28ed8cdac85dead"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a41bda11f4ca3d566a97c9fe65482109e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#a41bda11f4ca3d566a97c9fe65482109e">JSONRPCRequest</a> (const std::string &amp;strMethod, const <a class="el" href="classUniValue.html">UniValue</a> &amp;params, const <a class="el" href="classUniValue.html">UniValue</a> &amp;id)</td></tr>
<tr class="separator:a41bda11f4ca3d566a97c9fe65482109e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3b7dd20357d54461794da1213448ed8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUniValue.html">UniValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#ac3b7dd20357d54461794da1213448ed8">JSONRPCReplyObj</a> (const <a class="el" href="classUniValue.html">UniValue</a> &amp;result, const <a class="el" href="classUniValue.html">UniValue</a> &amp;<a class="el" href="util_8h.html#af8985880cf4ef26df0a5aa2ffcb76662">error</a>, const <a class="el" href="classUniValue.html">UniValue</a> &amp;id)</td></tr>
<tr class="separator:ac3b7dd20357d54461794da1213448ed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fdb4c40b8481244f300c15abe90c6bd"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#a2fdb4c40b8481244f300c15abe90c6bd">JSONRPCReply</a> (const <a class="el" href="classUniValue.html">UniValue</a> &amp;result, const <a class="el" href="classUniValue.html">UniValue</a> &amp;<a class="el" href="util_8h.html#af8985880cf4ef26df0a5aa2ffcb76662">error</a>, const <a class="el" href="classUniValue.html">UniValue</a> &amp;id)</td></tr>
<tr class="separator:a2fdb4c40b8481244f300c15abe90c6bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40b75d3d265c4a2e1d5fe3e129743884"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUniValue.html">UniValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#a40b75d3d265c4a2e1d5fe3e129743884">JSONRPCError</a> (int code, const std::string &amp;message)</td></tr>
<tr class="separator:a40b75d3d265c4a2e1d5fe3e129743884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae8ad79d1767e2f4b1207c1af53af7c3"><td class="memItemLeft" align="right" valign="top">boost::filesystem::path&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#aae8ad79d1767e2f4b1207c1af53af7c3">GetAuthCookieFile</a> ()</td></tr>
<tr class="separator:aae8ad79d1767e2f4b1207c1af53af7c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba0ca0057b433bdfcb881fcd6af4b577"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#aba0ca0057b433bdfcb881fcd6af4b577">GenerateAuthCookie</a> (std::string *cookie_out)</td></tr>
<tr class="separator:aba0ca0057b433bdfcb881fcd6af4b577"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25c502e3691e714e8a130c2325d40d63"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#a25c502e3691e714e8a130c2325d40d63">GetAuthCookie</a> (std::string *cookie_out)</td></tr>
<tr class="separator:a25c502e3691e714e8a130c2325d40d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9807259ee7b7c4f5445cf54fd23589cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rpc_2protocol_8h.html#a9807259ee7b7c4f5445cf54fd23589cb">DeleteAuthCookie</a> ()</td></tr>
<tr class="separator:a9807259ee7b7c4f5445cf54fd23589cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ab0a9668b7d736b4d4d621ec010928a46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0a9668b7d736b4d4d621ec010928a46">&#9670;&nbsp;</a></span>HTTPStatusCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="rpc_2protocol_8h.html#ab0a9668b7d736b4d4d621ec010928a46">HTTPStatusCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>HTTP status codes. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46a43f8027764325bbcad2f773511156d0a"></a>HTTP_OK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46a173b2a55d636fe537b9069a4fb3388f2"></a>HTTP_BAD_REQUEST&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46a74677f364201a3d068bc6b9db7359288"></a>HTTP_UNAUTHORIZED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46a7aec6e8ecb79ff84830a69e52ff01d17"></a>HTTP_FORBIDDEN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46a7a2f2a109c030ee9d2d5afe761232451"></a>HTTP_NOT_FOUND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46a40d47a5f8adc6d74c1ec977528a36edf"></a>HTTP_BAD_METHOD&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46ac7d2e49bfead01d65a890a2e80e5b3a6"></a>HTTP_INTERNAL_SERVER_ERROR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ab0a9668b7d736b4d4d621ec010928a46a6251d4710923e5253b159943405a1a3a"></a>HTTP_SERVICE_UNAVAILABLE&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8h_source.html#l00018">18</a> of file <a class="el" href="rpc_2protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<a id="af867221d51315471f28ed8cdac85dead"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af867221d51315471f28ed8cdac85dead">&#9670;&nbsp;</a></span>RPCErrorCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="rpc_2protocol_8h.html#af867221d51315471f28ed8cdac85dead">RPCErrorCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dash Core RPC error codes. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadaf8310a778a7a84d76adde337d695fd0d"></a>RPC_INVALID_REQUEST&#160;</td><td class="fielddoc"><p>Standard JSON-RPC 2.0 errors. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada730bd898e0c5940282c275f49470a794"></a>RPC_METHOD_NOT_FOUND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada784a3cc09b65fa47ff1d70fbd3bfbaca"></a>RPC_INVALID_PARAMS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadad4f5ea69465f2a32fda9b9bf5e698803"></a>RPC_INTERNAL_ERROR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada3632e7ba1deeda31ff77fe80bdaf7fe6"></a>RPC_PARSE_ERROR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada5aa884a9e263e1fad4ad13ec564d33d5"></a>RPC_MISC_ERROR&#160;</td><td class="fielddoc"><p>General application defined errors. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada456d9eafa45bb1041024b834a063ea80"></a>RPC_FORBIDDEN_BY_SAFE_MODE&#160;</td><td class="fielddoc"><p>std::exception thrown in command handling </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada7c63246a7c7bc5912d499fb117358506"></a>RPC_TYPE_ERROR&#160;</td><td class="fielddoc"><p>Server is in safe mode, and command is not allowed in safe mode. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadafb8d27e000f4a668b66974c73256a576"></a>RPC_INVALID_ADDRESS_OR_KEY&#160;</td><td class="fielddoc"><p>Unexpected type was passed as parameter. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada2b50733804d98a7d4f2252563d864a66"></a>RPC_OUT_OF_MEMORY&#160;</td><td class="fielddoc"><p>Invalid address or key. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadab38a9a653209a57acfc9a551c310e4dc"></a>RPC_INVALID_PARAMETER&#160;</td><td class="fielddoc"><p>Ran out of memory during operation. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadadcfa95f6aca9c3a474fffac8c8ab1dd1"></a>RPC_DATABASE_ERROR&#160;</td><td class="fielddoc"><p>Invalid, missing or duplicate parameter. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadae41723a0e8091c7853a1e582e317b272"></a>RPC_DESERIALIZATION_ERROR&#160;</td><td class="fielddoc"><p>Database error. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadac8a991699304f068eb1d77e923b5c72f"></a>RPC_VERIFY_ERROR&#160;</td><td class="fielddoc"><p>Error parsing or validating structure in raw format. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadaf85dae2af118644e7aec72ffbc97c1c6"></a>RPC_VERIFY_REJECTED&#160;</td><td class="fielddoc"><p>General error during transaction or block submission. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada074c4989af08b8a44674cd1a7fd84be5"></a>RPC_VERIFY_ALREADY_IN_CHAIN&#160;</td><td class="fielddoc"><p>Transaction or block was rejected by network rules. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadab8aee859ef513c81f87aa298e8c0cf7c"></a>RPC_IN_WARMUP&#160;</td><td class="fielddoc"><p>Transaction already in chain. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadaa2bc9f33fd0ba09e486eeeeafaae968c"></a>RPC_TRANSACTION_ERROR&#160;</td><td class="fielddoc"><p>Client still warming up. </p>
<p>Aliases for backward compatibility </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada9e05169dd202b16a07bc124bd6e451d5"></a>RPC_TRANSACTION_REJECTED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada7a1b53103d599a098159e4f8171c4387"></a>RPC_TRANSACTION_ALREADY_IN_CHAIN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadaab5f4888435073da8cd11d99d274c8af"></a>RPC_CLIENT_NOT_CONNECTED&#160;</td><td class="fielddoc"><p>P2P client errors. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadadd3692758a03ba3dcd1accbdd656b27f"></a>RPC_CLIENT_IN_INITIAL_DOWNLOAD&#160;</td><td class="fielddoc"><p>Dash Core is not connected. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada69beae07cb7520bde6d66c32ebde05c4"></a>RPC_CLIENT_NODE_ALREADY_ADDED&#160;</td><td class="fielddoc"><p>Still downloading initial blocks. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadadd603a70e2d6eb11ef5b3aad2f83fd70"></a>RPC_CLIENT_NODE_NOT_ADDED&#160;</td><td class="fielddoc"><p>Node is already added. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada02613c7ff5b899411910a3d69ab3a47a"></a>RPC_CLIENT_NODE_NOT_CONNECTED&#160;</td><td class="fielddoc"><p>Node has not been added before. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada47dd1e11bdbe307d901c99589c584b9f"></a>RPC_CLIENT_INVALID_IP_OR_SUBNET&#160;</td><td class="fielddoc"><p>Node to disconnect not found in connected nodes. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadafec84f7fdd91f69c7d5f89a020be9f70"></a>RPC_CLIENT_P2P_DISABLED&#160;</td><td class="fielddoc"><p>Invalid IP/Subnet. </p>
<p>No valid connection manager instance found </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadaba6f8682002fa223d3a405b743b5a540"></a>RPC_WALLET_ERROR&#160;</td><td class="fielddoc"><p>Wallet errors. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada5e46fc2ff7c51b8423b6eaf5b33ebfb9"></a>RPC_WALLET_INSUFFICIENT_FUNDS&#160;</td><td class="fielddoc"><p>Unspecified problem with wallet (key not found etc.) </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada05642c62794bf107e9be801e76a4c89e"></a>RPC_WALLET_INVALID_ACCOUNT_NAME&#160;</td><td class="fielddoc"><p>Not enough funds in wallet or account. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadadacb2152d14607886f90ed134c94e21d"></a>RPC_WALLET_KEYPOOL_RAN_OUT&#160;</td><td class="fielddoc"><p>Invalid account name. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada0c1fbdf17d83da9f5124f2dbf0ba4765"></a>RPC_WALLET_UNLOCK_NEEDED&#160;</td><td class="fielddoc"><p>Keypool ran out, call keypoolrefill first. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deadae7f578c2ec4458c79250e204505dedcc"></a>RPC_WALLET_PASSPHRASE_INCORRECT&#160;</td><td class="fielddoc"><p>Enter the wallet passphrase with walletpassphrase first. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada6aa5da515d4b7230dfeb65017b9fd38d"></a>RPC_WALLET_WRONG_ENC_STATE&#160;</td><td class="fielddoc"><p>The wallet passphrase entered was incorrect. </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada796c728d5ec3fc308609494e1d608940"></a>RPC_WALLET_ENCRYPTION_FAILED&#160;</td><td class="fielddoc"><p>Command given in wrong wallet encryption state (encrypting an encrypted wallet etc.) </p>
</td></tr>
<tr><td class="fieldname"><a id="af867221d51315471f28ed8cdac85deada13d89bf3248220d312af052959f71b0b"></a>RPC_WALLET_ALREADY_UNLOCKED&#160;</td><td class="fielddoc"><p>Failed to encrypt the wallet. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8h_source.html#l00031">31</a> of file <a class="el" href="rpc_2protocol_8h_source.html">protocol.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a9807259ee7b7c4f5445cf54fd23589cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9807259ee7b7c4f5445cf54fd23589cb">&#9670;&nbsp;</a></span>DeleteAuthCookie()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DeleteAuthCookie </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete RPC authentication cookie from disk </p>
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8cpp_source.html#l00122">122</a> of file <a class="el" href="rpc_2protocol_8cpp_source.html">protocol.cpp</a>.</p>
</div>
</div>
<a id="aba0ca0057b433bdfcb881fcd6af4b577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba0ca0057b433bdfcb881fcd6af4b577">&#9670;&nbsp;</a></span>GenerateAuthCookie()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool GenerateAuthCookie </td>
<td>(</td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>cookie_out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a new RPC authentication cookie and write it to disk </p>
<p>the umask determines what permissions are used to create this file - these are set to 077 in <a class="el" href="init_8cpp.html">init.cpp</a> unless overridden with -sysperms.</p>
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8cpp_source.html#l00079">79</a> of file <a class="el" href="rpc_2protocol_8cpp_source.html">protocol.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="httprpc_8cpp_source.html#l00206">InitRPCAuthentication()</a>.</p>
</div>
</div>
<a id="a25c502e3691e714e8a130c2325d40d63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25c502e3691e714e8a130c2325d40d63">&#9670;&nbsp;</a></span>GetAuthCookie()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool GetAuthCookie </td>
<td>(</td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>cookie_out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the RPC authentication cookie from disk </p>
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8cpp_source.html#l00106">106</a> of file <a class="el" href="rpc_2protocol_8cpp_source.html">protocol.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="dash-cli_8cpp_source.html#l00158">CallRPC()</a>.</p>
</div>
</div>
<a id="aae8ad79d1767e2f4b1207c1af53af7c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae8ad79d1767e2f4b1207c1af53af7c3">&#9670;&nbsp;</a></span>GetAuthCookieFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::filesystem::path GetAuthCookieFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name of RPC authentication cookie file </p>
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8cpp_source.html#l00072">72</a> of file <a class="el" href="rpc_2protocol_8cpp_source.html">protocol.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="rpc_2protocol_8cpp_source.html#l00122">DeleteAuthCookie()</a>, <a class="el" href="rpc_2protocol_8cpp_source.html#l00079">GenerateAuthCookie()</a>, and <a class="el" href="rpc_2protocol_8cpp_source.html#l00106">GetAuthCookie()</a>.</p>
</div>
</div>
<a id="a40b75d3d265c4a2e1d5fe3e129743884"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40b75d3d265c4a2e1d5fe3e129743884">&#9670;&nbsp;</a></span>JSONRPCError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUniValue.html">UniValue</a> JSONRPCError </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>message</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2fdb4c40b8481244f300c15abe90c6bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fdb4c40b8481244f300c15abe90c6bd">&#9670;&nbsp;</a></span>JSONRPCReply()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string JSONRPCReply </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8cpp_source.html#l00051">51</a> of file <a class="el" href="rpc_2protocol_8cpp_source.html">protocol.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="httprpc_8cpp_source.html#l00143">HTTPReq_JSONRPC()</a>, and <a class="el" href="httprpc_8cpp_source.html#l00065">JSONErrorReply()</a>.</p>
</div>
</div>
<a id="ac3b7dd20357d54461794da1213448ed8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3b7dd20357d54461794da1213448ed8">&#9670;&nbsp;</a></span>JSONRPCReplyObj()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUniValue.html">UniValue</a> JSONRPCReplyObj </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpc_2protocol_8cpp_source.html#l00039">39</a> of file <a class="el" href="rpc_2protocol_8cpp_source.html">protocol.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="server_8cpp_source.html#l00508">JSONRPCExecOne()</a>, and <a class="el" href="rpc_2protocol_8cpp_source.html#l00051">JSONRPCReply()</a>.</p>
</div>
</div>
<a id="a41bda11f4ca3d566a97c9fe65482109e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41bda11f4ca3d566a97c9fe65482109e">&#9670;&nbsp;</a></span>JSONRPCRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string JSONRPCRequest </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>strMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUniValue.html">UniValue</a> &amp;&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_1d8fd1f10602b1b3ec6e7b702d4ec182.html">rpc</a></li><li class="navelem"><a class="el" href="rpc_2protocol_8h.html">protocol.h</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:10 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink