ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3df04aee413816519feb9aa2ea6a34667fd2037b
rippled/classripple_1_1Resource_1_1Consumer.html
manojsdoshi 3ded95240d deploy: 4ec11e692b
2021-12-17 19:04:33 +00:00

566 lines
33 KiB
HTML
Raw Blame History

<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::Resource::Consumer 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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
<!-- 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 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_1Resource.html">Resource</a></li><li class="navelem"><a class="el" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classripple_1_1Resource_1_1Consumer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::Resource::Consumer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An endpoint that consumes resources.
<a href="classripple_1_1Resource_1_1Consumer.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::Resource::Consumer:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Resource_1_1Consumer__coll__graph.png" border="0" usemap="#ripple_1_1Resource_1_1Consumer_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1Resource_1_1Consumer_coll__map" id="ripple_1_1Resource_1_1Consumer_coll__map">
<area shape="rect" title="An endpoint that consumes resources." alt="" coords="1105,100,1305,127"/>
<area shape="rect" href="structripple_1_1Resource_1_1Import_1_1Item.html" title=" " alt="" coords="1426,118,1603,159"/>
<area shape="rect" href="classripple_1_1Resource_1_1Logic.html" title=" " alt="" coords="2591,204,2759,231"/>
<area shape="rect" href="classbeast_1_1abstract__clock.html" title=" " alt="" coords="207,284,368,340"/>
<area shape="rect" href="classripple_1_1DecayingSample.html" title=" " alt="" coords="476,211,683,282"/>
<area shape="rect" href="structripple_1_1Resource_1_1Logic_1_1Stats.html" title=" " alt="" coords="2285,233,2453,274"/>
<area shape="rect" href="classbeast_1_1insight_1_1Meter.html" title="A metric for measuring an integral value." alt="" coords="2006,216,2161,243"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1720,199,1891,241"/>
<area shape="rect" href="classbeast_1_1insight_1_1MeterImpl.html" title=" " alt="" coords="1423,207,1607,233"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="1112,199,1299,241"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title="STL class." alt="" coords="2290,181,2449,208"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="2285,115,2453,157"/>
<area shape="rect" href="structripple_1_1Resource_1_1Import.html" title="A set of imported consumer data from a gossip origin." alt="" coords="1995,165,2172,192"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1731,117,1879,173"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="2040,115,2127,141"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="2293,316,2446,343"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="1999,318,2167,359"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="1721,318,1889,359"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="2039,267,2127,293"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="1110,5,1301,61"/>
<area shape="rect" href="structripple_1_1Resource_1_1Key.html" title=" " alt="" coords="500,31,659,57"/>
<area shape="rect" href="structripple_1_1Resource_1_1Entry.html" title=" " alt="" coords="824,100,992,127"/>
<area shape="rect" href="classbeast_1_1IP_1_1Endpoint.html" title="A version&#45;independent IP address and port combination." alt="" coords="216,31,359,57"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,31,108,57"/>
<area shape="rect" title=" " alt="" coords="510,93,649,134"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="2314,435,2425,461"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="2010,435,2157,461"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a45943fb23e4a91f253664ef138beef5f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a45943fb23e4a91f253664ef138beef5f">Consumer</a> ()</td></tr>
<tr class="separator:a45943fb23e4a91f253664ef138beef5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb78dbde97d941cdd72a31fe573da014"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#afb78dbde97d941cdd72a31fe573da014">~Consumer</a> ()</td></tr>
<tr class="separator:afb78dbde97d941cdd72a31fe573da014"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f38b4816f4b2e7d6b5f75e4eb9c5e88"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a0f38b4816f4b2e7d6b5f75e4eb9c5e88">Consumer</a> (<a class="el" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> const &amp;other)</td></tr>
<tr class="separator:a0f38b4816f4b2e7d6b5f75e4eb9c5e88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30b81218a3be2a2a28ce2a4218f1dacf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a30b81218a3be2a2a28ce2a4218f1dacf">operator=</a> (<a class="el" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> const &amp;other)</td></tr>
<tr class="separator:a30b81218a3be2a2a28ce2a4218f1dacf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a503ea58eb052215f605ede3e009df17a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a503ea58eb052215f605ede3e009df17a">to_string</a> () const</td></tr>
<tr class="memdesc:a503ea58eb052215f605ede3e009df17a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a human readable string uniquely identifying this consumer. <a href="classripple_1_1Resource_1_1Consumer.html#a503ea58eb052215f605ede3e009df17a">More...</a><br /></td></tr>
<tr class="separator:a503ea58eb052215f605ede3e009df17a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa196f44968e79d8c852e15ac96a71ee3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#aa196f44968e79d8c852e15ac96a71ee3">isUnlimited</a> () const</td></tr>
<tr class="memdesc:aa196f44968e79d8c852e15ac96a71ee3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if this is a privileged endpoint. <a href="classripple_1_1Resource_1_1Consumer.html#aa196f44968e79d8c852e15ac96a71ee3">More...</a><br /></td></tr>
<tr class="separator:aa196f44968e79d8c852e15ac96a71ee3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6ce4aef62d151f2ed8750eb79596a5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#ae6ce4aef62d151f2ed8750eb79596a5a">elevate</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;name)</td></tr>
<tr class="memdesc:ae6ce4aef62d151f2ed8750eb79596a5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raise the <a class="el" href="classripple_1_1Resource_1_1Consumer.html" title="An endpoint that consumes resources.">Consumer</a>'s privilege level to a Named endpoint. <a href="classripple_1_1Resource_1_1Consumer.html#ae6ce4aef62d151f2ed8750eb79596a5a">More...</a><br /></td></tr>
<tr class="separator:ae6ce4aef62d151f2ed8750eb79596a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7cedbf4822211a1c627483b36d8a2b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1Resource.html#ae12997de115c1cf0032794aa5ea1b15d">Disposition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#ad7cedbf4822211a1c627483b36d8a2b4">disposition</a> () const</td></tr>
<tr class="memdesc:ad7cedbf4822211a1c627483b36d8a2b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current disposition of this consumer. <a href="classripple_1_1Resource_1_1Consumer.html#ad7cedbf4822211a1c627483b36d8a2b4">More...</a><br /></td></tr>
<tr class="separator:ad7cedbf4822211a1c627483b36d8a2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65d4f295e044ae0bf1e5ef1e4e6df539"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1Resource.html#ae12997de115c1cf0032794aa5ea1b15d">Disposition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a65d4f295e044ae0bf1e5ef1e4e6df539">charge</a> (<a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a> const &amp;fee)</td></tr>
<tr class="memdesc:a65d4f295e044ae0bf1e5ef1e4e6df539"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply a load charge to the consumer. <a href="classripple_1_1Resource_1_1Consumer.html#a65d4f295e044ae0bf1e5ef1e4e6df539">More...</a><br /></td></tr>
<tr class="separator:a65d4f295e044ae0bf1e5ef1e4e6df539"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27db21f6a4965d2ade4ba1761e3d8ccd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a27db21f6a4965d2ade4ba1761e3d8ccd">warn</a> ()</td></tr>
<tr class="memdesc:a27db21f6a4965d2ade4ba1761e3d8ccd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if the consumer should be warned. <a href="classripple_1_1Resource_1_1Consumer.html#a27db21f6a4965d2ade4ba1761e3d8ccd">More...</a><br /></td></tr>
<tr class="separator:a27db21f6a4965d2ade4ba1761e3d8ccd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5463a664bf34b5c191192ba4b04a9f82"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a5463a664bf34b5c191192ba4b04a9f82">disconnect</a> (<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp;j)</td></tr>
<tr class="memdesc:a5463a664bf34b5c191192ba4b04a9f82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if the consumer should be disconnected. <a href="classripple_1_1Resource_1_1Consumer.html#a5463a664bf34b5c191192ba4b04a9f82">More...</a><br /></td></tr>
<tr class="separator:a5463a664bf34b5c191192ba4b04a9f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a320fc29f63c46d86d9564dcd3a3b20bb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a320fc29f63c46d86d9564dcd3a3b20bb">balance</a> ()</td></tr>
<tr class="memdesc:a320fc29f63c46d86d9564dcd3a3b20bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the credit balance representing consumption. <a href="classripple_1_1Resource_1_1Consumer.html#a320fc29f63c46d86d9564dcd3a3b20bb">More...</a><br /></td></tr>
<tr class="separator:a320fc29f63c46d86d9564dcd3a3b20bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aa9f758afee2c0944729ae1e95a782f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1Resource_1_1Entry.html">Entry</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a5aa9f758afee2c0944729ae1e95a782f">entry</a> ()</td></tr>
<tr class="separator:a5aa9f758afee2c0944729ae1e95a782f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a0c9eb0288546592ad6a95db825712413"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a0c9eb0288546592ad6a95db825712413">Consumer</a> (<a class="el" href="classripple_1_1Resource_1_1Logic.html">Logic</a> &amp;logic, <a class="el" href="structripple_1_1Resource_1_1Entry.html">Entry</a> &amp;<a class="el" href="classripple_1_1Resource_1_1Consumer.html#a5aa9f758afee2c0944729ae1e95a782f">entry</a>)</td></tr>
<tr class="separator:a0c9eb0288546592ad6a95db825712413"><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:a9cf4227f9e9d777f68a87566c7c55a1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Resource_1_1Logic.html">Logic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a9cf4227f9e9d777f68a87566c7c55a1b">m_logic</a></td></tr>
<tr class="separator:a9cf4227f9e9d777f68a87566c7c55a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a258b89dc1702add977873f92f68e2368"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1Resource_1_1Entry.html">Entry</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#a258b89dc1702add977873f92f68e2368">m_entry</a></td></tr>
<tr class="separator:a258b89dc1702add977873f92f68e2368"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac43d5e79030c986e4bd98e5155d079a4"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Consumer.html#ac43d5e79030c986e4bd98e5155d079a4">Logic</a></td></tr>
<tr class="separator:ac43d5e79030c986e4bd98e5155d079a4"><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>An endpoint that consumes resources. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8h_source.html#l00034">34</a> of file <a class="el" href="Consumer_8h_source.html">Consumer.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0c9eb0288546592ad6a95db825712413"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c9eb0288546592ad6a95db825712413">&#9670;&nbsp;</a></span>Consumer() <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">ripple::Resource::Consumer::Consumer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Resource_1_1Logic.html">Logic</a> &amp;&#160;</td>
<td class="paramname"><em>logic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1Resource_1_1Entry.html">Entry</a> &amp;&#160;</td>
<td class="paramname"><em>entry</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">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00028">28</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a45943fb23e4a91f253664ef138beef5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45943fb23e4a91f253664ef138beef5f">&#9670;&nbsp;</a></span>Consumer() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Resource::Consumer::Consumer </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="Consumer_8cpp_source.html#l00033">33</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="afb78dbde97d941cdd72a31fe573da014"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb78dbde97d941cdd72a31fe573da014">&#9670;&nbsp;</a></span>~Consumer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Resource::Consumer::~Consumer </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="Consumer_8cpp_source.html#l00047">47</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a0f38b4816f4b2e7d6b5f75e4eb9c5e88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f38b4816f4b2e7d6b5f75e4eb9c5e88">&#9670;&nbsp;</a></span>Consumer() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Resource::Consumer::Consumer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> const &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00037">37</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a30b81218a3be2a2a28ce2a4218f1dacf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30b81218a3be2a2a28ce2a4218f1dacf">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> &amp; ripple::Resource::Consumer::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> const &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00054">54</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a503ea58eb052215f605ede3e009df17a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a503ea58eb052215f605ede3e009df17a">&#9670;&nbsp;</a></span>to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::Resource::Consumer::to_string </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a human readable string uniquely identifying this consumer. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00071">71</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="aa196f44968e79d8c852e15ac96a71ee3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa196f44968e79d8c852e15ac96a71ee3">&#9670;&nbsp;</a></span>isUnlimited()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::Resource::Consumer::isUnlimited </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if this is a privileged endpoint. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00080">80</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="ae6ce4aef62d151f2ed8750eb79596a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ce4aef62d151f2ed8750eb79596a5a">&#9670;&nbsp;</a></span>elevate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::Resource::Consumer::elevate </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Raise the <a class="el" href="classripple_1_1Resource_1_1Consumer.html" title="An endpoint that consumes resources.">Consumer</a>'s privilege level to a Named endpoint. </p>
<p>The reference to the original endpoint descriptor is released. </p>
</div>
</div>
<a id="ad7cedbf4822211a1c627483b36d8a2b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7cedbf4822211a1c627483b36d8a2b4">&#9670;&nbsp;</a></span>disposition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple_1_1Resource.html#ae12997de115c1cf0032794aa5ea1b15d">Disposition</a> ripple::Resource::Consumer::disposition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current disposition of this consumer. </p>
<p>This should be checked upon creation to determine if the consumer should be disconnected immediately. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00089">89</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a65d4f295e044ae0bf1e5ef1e4e6df539"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65d4f295e044ae0bf1e5ef1e4e6df539">&#9670;&nbsp;</a></span>charge()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple_1_1Resource.html#ae12997de115c1cf0032794aa5ea1b15d">Disposition</a> ripple::Resource::Consumer::charge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a> const &amp;&#160;</td>
<td class="paramname"><em>fee</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply a load charge to the consumer. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00099">99</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a27db21f6a4965d2ade4ba1761e3d8ccd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27db21f6a4965d2ade4ba1761e3d8ccd">&#9670;&nbsp;</a></span>warn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::Resource::Consumer::warn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if the consumer should be warned. </p>
<p>This consumes the warning. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00110">110</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a5463a664bf34b5c191192ba4b04a9f82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5463a664bf34b5c191192ba4b04a9f82">&#9670;&nbsp;</a></span>disconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::Resource::Consumer::disconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp;&#160;</td>
<td class="paramname"><em>j</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>true</code> if the consumer should be disconnected. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00117">117</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a320fc29f63c46d86d9564dcd3a3b20bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a320fc29f63c46d86d9564dcd3a3b20bb">&#9670;&nbsp;</a></span>balance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ripple::Resource::Consumer::balance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the credit balance representing consumption. </p>
<p class="definition">Definition at line <a class="el" href="Consumer_8cpp_source.html#l00129">129</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a5aa9f758afee2c0944729ae1e95a782f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5aa9f758afee2c0944729ae1e95a782f">&#9670;&nbsp;</a></span>entry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1Resource_1_1Entry.html">Entry</a> &amp; ripple::Resource::Consumer::entry </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="Consumer_8cpp_source.html#l00136">136</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="ac43d5e79030c986e4bd98e5155d079a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac43d5e79030c986e4bd98e5155d079a4">&#9670;&nbsp;</a></span>Logic</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classripple_1_1Resource_1_1Logic.html">Logic</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Consumer_8h_source.html#l00037">37</a> of file <a class="el" href="Consumer_8h_source.html">Consumer.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9cf4227f9e9d777f68a87566c7c55a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cf4227f9e9d777f68a87566c7c55a1b">&#9670;&nbsp;</a></span>m_logic</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Resource_1_1Logic.html">Logic</a>* ripple::Resource::Consumer::m_logic</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="Consumer_8h_source.html#l00091">91</a> of file <a class="el" href="Consumer_8h_source.html">Consumer.h</a>.</p>
</div>
</div>
<a id="a258b89dc1702add977873f92f68e2368"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a258b89dc1702add977873f92f68e2368">&#9670;&nbsp;</a></span>m_entry</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1Resource_1_1Entry.html">Entry</a>* ripple::Resource::Consumer::m_entry</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="Consumer_8h_source.html#l00092">92</a> of file <a class="el" href="Consumer_8h_source.html">Consumer.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink