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/classCRPCTable.html

297 lines
14 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: CRPCTable 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="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('classCRPCTable.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classCRPCTable-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CRPCTable Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="server_8h_source.html">server.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2e6e624bae4c149db2f5cbe0de84b121"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCRPCTable.html#a2e6e624bae4c149db2f5cbe0de84b121">CRPCTable</a> ()</td></tr>
<tr class="separator:a2e6e624bae4c149db2f5cbe0de84b121"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa06a59b1f7fe34668eab9a6a4a2491fa"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCRPCCommand.html">CRPCCommand</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCRPCTable.html#aa06a59b1f7fe34668eab9a6a4a2491fa">operator[]</a> (const std::string &amp;<a class="el" href="rest_8cpp.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>) const</td></tr>
<tr class="separator:aa06a59b1f7fe34668eab9a6a4a2491fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d9af8e5975ee8d872b49992faae3ba6"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCRPCTable.html#a3d9af8e5975ee8d872b49992faae3ba6">help</a> (const std::string &amp;<a class="el" href="rest_8cpp.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>) const</td></tr>
<tr class="separator:a3d9af8e5975ee8d872b49992faae3ba6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30bfd77e85ecc56b58da3f8582af1ac8"><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="classCRPCTable.html#a30bfd77e85ecc56b58da3f8582af1ac8">execute</a> (const std::string &amp;method, const <a class="el" href="classUniValue.html">UniValue</a> &amp;params) const</td></tr>
<tr class="separator:a30bfd77e85ecc56b58da3f8582af1ac8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ebce2fd23e8343e42d36a9bcd02de95"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCRPCTable.html#a7ebce2fd23e8343e42d36a9bcd02de95">listCommands</a> () const</td></tr>
<tr class="separator:a7ebce2fd23e8343e42d36a9bcd02de95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:abe193d7f72d98048f2a99ec13028f65f"><td class="memItemLeft" align="right" valign="top">std::map&lt; std::string, const <a class="el" href="classCRPCCommand.html">CRPCCommand</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCRPCTable.html#abe193d7f72d98048f2a99ec13028f65f">mapCommands</a></td></tr>
<tr class="separator:abe193d7f72d98048f2a99ec13028f65f"><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>Dash RPC command dispatcher. </p>
<p class="definition">Definition at line <a class="el" href="server_8h_source.html#l00128">128</a> of file <a class="el" href="server_8h_source.html">server.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2e6e624bae4c149db2f5cbe0de84b121"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e6e624bae4c149db2f5cbe0de84b121">&#9670;&nbsp;</a></span>CRPCTable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CRPCTable::CRPCTable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="server_8cpp_source.html#l00410">410</a> of file <a class="el" href="server_8cpp_source.html">server.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a30bfd77e85ecc56b58da3f8582af1ac8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30bfd77e85ecc56b58da3f8582af1ac8">&#9670;&nbsp;</a></span>execute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUniValue.html">UniValue</a> CRPCTable::execute </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>method</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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute a method. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">method</td><td>Method to execute </td></tr>
<tr><td class="paramname">params</td><td><a class="el" href="classUniValue.html">UniValue</a> Array of arguments (JSON objects) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result of the call. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">an</td><td>exception (<a class="el" href="classUniValue.html">UniValue</a>) when an error happens. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="server_8cpp_source.html#l00541">541</a> of file <a class="el" href="server_8cpp_source.html">server.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="httprpc_8cpp_source.html#l00143">HTTPReq_JSONRPC()</a>, <a class="el" href="server_8cpp_source.html#l00508">JSONRPCExecOne()</a>, and <a class="el" href="rpcconsole_8cpp_source.html#l00205">RPCExecutor::request()</a>.</p>
</div>
</div>
<a id="a3d9af8e5975ee8d872b49992faae3ba6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d9af8e5975ee8d872b49992faae3ba6">&#9670;&nbsp;</a></span>help()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string CRPCTable::help </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>strCommand</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Note: This interface may still be subject to change. </p>
<p class="definition">Definition at line <a class="el" href="server_8cpp_source.html#l00165">165</a> of file <a class="el" href="server_8cpp_source.html">server.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="server_8cpp_source.html#l00220">help()</a>.</p>
</div>
</div>
<a id="a7ebce2fd23e8343e42d36a9bcd02de95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ebce2fd23e8343e42d36a9bcd02de95">&#9670;&nbsp;</a></span>listCommands()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; std::string &gt; CRPCTable::listCommands </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a list of registered commands </p><dl class="section return"><dt>Returns</dt><dd>List of registered commands. </dd></dl>
<p class="definition">Definition at line <a class="el" href="server_8cpp_source.html#l00570">570</a> of file <a class="el" href="server_8cpp_source.html">server.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="rpcconsole_8cpp_source.html#l00368">RPCConsole::setClientModel()</a>.</p>
</div>
</div>
<a id="aa06a59b1f7fe34668eab9a6a4a2491fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa06a59b1f7fe34668eab9a6a4a2491fa">&#9670;&nbsp;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCRPCCommand.html">CRPCCommand</a> * CRPCTable::operator[] </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="server_8cpp_source.html#l00422">422</a> of file <a class="el" href="server_8cpp_source.html">server.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abe193d7f72d98048f2a99ec13028f65f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe193d7f72d98048f2a99ec13028f65f">&#9670;&nbsp;</a></span>mapCommands</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::map&lt;std::string, const <a class="el" href="classCRPCCommand.html">CRPCCommand</a>*&gt; CRPCTable::mapCommands</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="server_8h_source.html#l00131">131</a> of file <a class="el" href="server_8h_source.html">server.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/rpc/<a class="el" href="server_8h_source.html">server.h</a></li>
<li>src/rpc/<a class="el" href="server_8cpp_source.html">server.cpp</a></li>
</ul>
</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="classCRPCTable.html">CRPCTable</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:12 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