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

639 lines
39 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::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 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_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>
<p><code>#include &lt;<a class="el" href="Consumer_8h_source.html">Consumer.h</a>&gt;</code></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="#aripple_1_1Resource_1_1Consumer_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Resource_1_1Consumer_coll__map" id="aripple_1_1Resource_1_1Consumer_coll__map">
<area shape="rect" title="An endpoint that consumes resources." alt="" coords="1084,299,1285,324"/>
<area shape="rect" href="structripple_1_1Resource_1_1Import_1_1Item.html" title=" " alt="" coords="1406,395,1585,435"/>
<area shape="poly" title=" " alt="" coords="1237,326,1435,393,1433,398,1236,331"/>
<area shape="rect" href="classripple_1_1Resource_1_1Logic.html" title=" " alt="" coords="2575,224,2744,249"/>
<area shape="poly" title=" " alt="" coords="2615,257,2563,275,2499,294,2427,308,2354,314,1494,314,1286,314,1286,309,1494,309,2354,309,2426,303,2497,289,2562,270,2614,252"/>
<area shape="rect" href="structripple_1_1Resource_1_1Logic_1_1Stats.html" title=" " alt="" coords="2268,70,2437,110"/>
<area shape="poly" title=" " alt="" coords="2438,112,2495,132,2552,158,2604,191,2644,222,2641,226,2601,195,2549,163,2493,137,2436,117"/>
<area shape="rect" href="classbeast_1_1insight_1_1Meter.html" title="A metric for measuring an integral value." alt="" coords="1987,77,2143,103"/>
<area shape="poly" title=" " alt="" coords="2157,87,2268,87,2268,93,2157,93"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1701,71,1872,111"/>
<area shape="poly" title=" " alt="" coords="1886,88,1987,88,1987,93,1886,94"/>
<area shape="rect" href="classbeast_1_1insight_1_1MeterImpl.html" title=" " alt="" coords="1403,89,1588,115"/>
<area shape="poly" title=" " alt="" coords="1601,95,1701,92,1701,97,1601,101"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="1091,85,1279,125"/>
<area shape="poly" title=" " alt="" coords="1292,101,1402,100,1402,105,1292,106"/>
<area shape="rect" href="classbeast_1_1abstract__clock.html" title="Abstract interface to a clock." alt="" coords="2273,134,2433,174"/>
<area shape="poly" title=" " alt="" coords="2447,172,2551,199,2622,221,2620,227,2550,205,2446,178"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="2297,199,2408,224"/>
<area shape="poly" title=" " alt="" coords="2422,214,2575,227,2574,232,2422,220"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1992,199,2139,224"/>
<area shape="poly" title=" " alt="" coords="2152,209,2297,209,2297,214,2152,214"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="2273,248,2432,273"/>
<area shape="poly" title=" " alt="" coords="2445,259,2550,254,2599,247,2600,252,2551,259,2446,265"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="1089,5,1280,60"/>
<area shape="poly" title=" " alt="" coords="1294,30,1494,30,2354,30,2414,33,2460,45,2503,68,2552,103,2585,132,2614,166,2653,222,2648,225,2610,169,2582,136,2549,107,2500,72,2458,50,2413,39,2354,35,1494,35,1294,35"/>
<area shape="rect" href="structripple_1_1Resource_1_1Key.html" title=" " alt="" coords="477,25,636,51"/>
<area shape="poly" title=" " alt="" coords="650,35,1089,31,1089,36,650,40"/>
<area shape="rect" href="structripple_1_1Resource_1_1Entry.html" title=" " alt="" coords="801,125,971,151"/>
<area shape="poly" title=" " alt="" coords="614,52,778,102,845,123,843,128,777,107,612,57"/>
<area shape="rect" href="classbeast_1_1IP_1_1Endpoint.html" title="A version&#45;independent IP address and port combination." alt="" coords="207,25,349,51"/>
<area shape="poly" title=" " alt="" coords="363,35,477,35,477,41,363,41"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,25,108,51"/>
<area shape="poly" title=" " alt="" coords="122,35,206,35,206,41,122,41"/>
<area shape="poly" title=" " alt="" coords="922,155,1163,296,1160,301,919,160"/>
<area shape="poly" title=" " alt="" coords="935,118,1105,58,1107,63,937,123"/>
<area shape="rect" title=" " alt="" coords="487,86,626,126"/>
<area shape="poly" title=" " alt="" coords="640,111,801,127,801,132,639,117"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="479,150,634,190"/>
<area shape="poly" title=" " alt="" coords="648,159,801,144,801,149,648,164"/>
<area shape="rect" href="classripple_1_1DecayingSample.html" title=" " alt="" coords="453,214,660,283"/>
<area shape="poly" title=" " alt="" coords="672,210,776,175,851,148,852,153,778,181,674,215"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="2276,377,2429,403"/>
<area shape="poly" title=" " alt="" coords="2424,402,2487,403,2519,398,2549,386,2570,373,2588,357,2617,318,2638,279,2651,249,2656,251,2643,281,2622,321,2592,360,2573,377,2552,391,2521,403,2488,409,2424,407"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="2021,349,2109,375"/>
<area shape="poly" title=" " alt="" coords="2124,365,2276,380,2275,385,2123,370"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="1981,402,2149,442"/>
<area shape="poly" title=" " alt="" coords="2163,418,2244,411,2303,400,2304,405,2244,417,2163,423"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="1703,402,1871,442"/>
<area shape="poly" title=" " alt="" coords="1884,419,1981,419,1981,425,1884,425"/>
<area shape="poly" title=" " alt="" coords="1761,386,1770,378,1787,375,1801,377,1811,383,1815,392,1813,402,1808,401,1809,393,1807,387,1799,382,1787,381,1772,383,1765,390"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="2269,466,2437,506"/>
<area shape="poly" title=" " alt="" coords="2449,470,2502,453,2549,425,2570,405,2589,382,2619,332,2640,284,2652,249,2657,250,2645,286,2624,334,2594,385,2574,409,2552,429,2504,458,2451,475"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="2022,473,2109,499"/>
<area shape="poly" title=" " alt="" coords="2122,483,2269,483,2269,489,2122,489"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="1717,466,1856,506"/>
<area shape="poly" title=" " alt="" coords="1870,483,2022,483,2022,489,1870,489"/>
<area shape="rect" href="structripple_1_1Resource_1_1Import.html" title="A set of imported consumer data from a gossip origin." alt="" coords="1976,528,2155,553"/>
<area shape="poly" title=" " alt="" coords="2145,523,2268,499,2269,505,2146,528"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1712,531,1861,585"/>
<area shape="poly" title=" " alt="" coords="1875,550,1976,544,1976,549,1875,555"/>
<area shape="poly" title=" " alt="" coords="1550,439,1703,516,1729,528,1726,533,1700,520,1547,444"/>
</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:a45943fb23e4a91f253664ef138beef5f" id="r_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" id="r_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" id="r_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" id="r_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" id="r_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. <br /></td></tr>
<tr class="separator:a503ea58eb052215f605ede3e009df17a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa196f44968e79d8c852e15ac96a71ee3" id="r_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. <br /></td></tr>
<tr class="separator:aa196f44968e79d8c852e15ac96a71ee3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6ce4aef62d151f2ed8750eb79596a5a" id="r_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. <br /></td></tr>
<tr class="separator:ae6ce4aef62d151f2ed8750eb79596a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7cedbf4822211a1c627483b36d8a2b4" id="r_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. <br /></td></tr>
<tr class="separator:ad7cedbf4822211a1c627483b36d8a2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a935e83cb32adf14651d2256783ad81d9" id="r_a935e83cb32adf14651d2256783ad81d9"><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#a935e83cb32adf14651d2256783ad81d9">charge</a> (<a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a> const &amp;fee, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;context={})</td></tr>
<tr class="memdesc:a935e83cb32adf14651d2256783ad81d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply a load charge to the consumer. <br /></td></tr>
<tr class="separator:a935e83cb32adf14651d2256783ad81d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27db21f6a4965d2ade4ba1761e3d8ccd" id="r_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. <br /></td></tr>
<tr class="separator:a27db21f6a4965d2ade4ba1761e3d8ccd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5463a664bf34b5c191192ba4b04a9f82" id="r_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. <br /></td></tr>
<tr class="separator:a5463a664bf34b5c191192ba4b04a9f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a320fc29f63c46d86d9564dcd3a3b20bb" id="r_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. <br /></td></tr>
<tr class="separator:a320fc29f63c46d86d9564dcd3a3b20bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aa9f758afee2c0944729ae1e95a782f" id="r_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>
<tr class="memitem:a9b53e05eb1381e1c2a37c77354a90834" id="r_a9b53e05eb1381e1c2a37c77354a90834"><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#a9b53e05eb1381e1c2a37c77354a90834">setPublicKey</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &amp;publicKey)</td></tr>
<tr class="separator:a9b53e05eb1381e1c2a37c77354a90834"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a0c9eb0288546592ad6a95db825712413" id="r_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 id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a9cf4227f9e9d777f68a87566c7c55a1b" id="r_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" id="r_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 id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac43d5e79030c986e4bd98e5155d079a4" id="r_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#l00016">16</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" name="a0c9eb0288546592ad6a95db825712413"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c9eb0288546592ad6a95db825712413">&#9670;&#160;</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#l00016">16</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a45943fb23e4a91f253664ef138beef5f" name="a45943fb23e4a91f253664ef138beef5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45943fb23e4a91f253664ef138beef5f">&#9670;&#160;</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#l00021">21</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="afb78dbde97d941cdd72a31fe573da014" name="afb78dbde97d941cdd72a31fe573da014"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb78dbde97d941cdd72a31fe573da014">&#9670;&#160;</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#l00035">35</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a0f38b4816f4b2e7d6b5f75e4eb9c5e88" name="a0f38b4816f4b2e7d6b5f75e4eb9c5e88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f38b4816f4b2e7d6b5f75e4eb9c5e88">&#9670;&#160;</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#l00025">25</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" name="a30b81218a3be2a2a28ce2a4218f1dacf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30b81218a3be2a2a28ce2a4218f1dacf">&#9670;&#160;</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#l00042">42</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a503ea58eb052215f605ede3e009df17a" name="a503ea58eb052215f605ede3e009df17a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a503ea58eb052215f605ede3e009df17a">&#9670;&#160;</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#l00059">59</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="aa196f44968e79d8c852e15ac96a71ee3" name="aa196f44968e79d8c852e15ac96a71ee3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa196f44968e79d8c852e15ac96a71ee3">&#9670;&#160;</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#l00068">68</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="ae6ce4aef62d151f2ed8750eb79596a5a" name="ae6ce4aef62d151f2ed8750eb79596a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ce4aef62d151f2ed8750eb79596a5a">&#9670;&#160;</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" name="ad7cedbf4822211a1c627483b36d8a2b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7cedbf4822211a1c627483b36d8a2b4">&#9670;&#160;</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#l00077">77</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a935e83cb32adf14651d2256783ad81d9" name="a935e83cb32adf14651d2256783ad81d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a935e83cb32adf14651d2256783ad81d9">&#9670;&#160;</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>
</tr>
<tr>
<td class="paramkey"></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>context</em> = <code>{}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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#l00087">87</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a27db21f6a4965d2ade4ba1761e3d8ccd" name="a27db21f6a4965d2ade4ba1761e3d8ccd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27db21f6a4965d2ade4ba1761e3d8ccd">&#9670;&#160;</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#l00098">98</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a5463a664bf34b5c191192ba4b04a9f82" name="a5463a664bf34b5c191192ba4b04a9f82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5463a664bf34b5c191192ba4b04a9f82">&#9670;&#160;</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#l00105">105</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a320fc29f63c46d86d9564dcd3a3b20bb" name="a320fc29f63c46d86d9564dcd3a3b20bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a320fc29f63c46d86d9564dcd3a3b20bb">&#9670;&#160;</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#l00118">118</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a5aa9f758afee2c0944729ae1e95a782f" name="a5aa9f758afee2c0944729ae1e95a782f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5aa9f758afee2c0944729ae1e95a782f">&#9670;&#160;</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#l00126">126</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<a id="a9b53e05eb1381e1c2a37c77354a90834" name="a9b53e05eb1381e1c2a37c77354a90834"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b53e05eb1381e1c2a37c77354a90834">&#9670;&#160;</a></span>setPublicKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::Resource::Consumer::setPublicKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &amp;&#160;</td>
<td class="paramname"><em>publicKey</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#l00133">133</a> of file <a class="el" href="Consumer_8cpp_source.html">Consumer.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="ac43d5e79030c986e4bd98e5155d079a4" name="ac43d5e79030c986e4bd98e5155d079a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac43d5e79030c986e4bd98e5155d079a4">&#9670;&#160;</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#l00019">19</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" name="a9cf4227f9e9d777f68a87566c7c55a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cf4227f9e9d777f68a87566c7c55a1b">&#9670;&#160;</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#l00076">76</a> of file <a class="el" href="Consumer_8h_source.html">Consumer.h</a>.</p>
</div>
</div>
<a id="a258b89dc1702add977873f92f68e2368" name="a258b89dc1702add977873f92f68e2368"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a258b89dc1702add977873f92f68e2368">&#9670;&#160;</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#l00077">77</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="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>