mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
190 lines
26 KiB
HTML
190 lines
26 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">
|
|
<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: Consumer.h Source File</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&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&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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_a49d03dbe37362975c505cb11669e4db.html">resource</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Consumer.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_RESOURCE_CONSUMER_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_RESOURCE_CONSUMER_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/basics/Log.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/resource/Charge.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/resource/Disposition.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>Resource {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">struct </span>Entry;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>Logic;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1Resource_1_1Consumer.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1Resource_1_1Consumer.html#ac43d5e79030c986e4bd98e5155d079a4"> 37</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classripple_1_1Resource_1_1Logic.html">Logic</a>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a45943fb23e4a91f253664ef138beef5f">Consumer</a>(<a class="code" href="classripple_1_1Resource_1_1Logic.html">Logic</a>& logic, <a class="code" href="structripple_1_1Resource_1_1Entry.html">Entry</a>& <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a5aa9f758afee2c0944729ae1e95a782f">entry</a>);</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a45943fb23e4a91f253664ef138beef5f">Consumer</a>();</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#afb78dbde97d941cdd72a31fe573da014">~Consumer</a>();</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a45943fb23e4a91f253664ef138beef5f">Consumer</a>(<a class="code" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> <span class="keyword">const</span>& other);</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a>&</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a30b81218a3be2a2a28ce2a4218f1dacf">operator=</a>(<a class="code" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> <span class="keyword">const</span>& other);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a503ea58eb052215f605ede3e009df17a">to_string</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#aa196f44968e79d8c852e15ac96a71ee3">isUnlimited</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#ae6ce4aef62d151f2ed8750eb79596a5a">elevate</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& name);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="namespaceripple_1_1Resource.html#ae12997de115c1cf0032794aa5ea1b15d">Disposition</a></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#ad7cedbf4822211a1c627483b36d8a2b4">disposition</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="namespaceripple_1_1Resource.html#ae12997de115c1cf0032794aa5ea1b15d">Disposition</a></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a65d4f295e044ae0bf1e5ef1e4e6df539">charge</a>(<a class="code" href="classripple_1_1Resource_1_1Charge.html">Charge</a> <span class="keyword">const</span>& fee);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a27db21f6a4965d2ade4ba1761e3d8ccd">warn</a>();</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a5463a664bf34b5c191192ba4b04a9f82">disconnect</a>(<a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> <span class="keyword">const</span>& j);</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a320fc29f63c46d86d9564dcd3a3b20bb">balance</a>();</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// Private: Retrieve the entry associated with the consumer</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="structripple_1_1Resource_1_1Entry.html">Entry</a>&</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a5aa9f758afee2c0944729ae1e95a782f">entry</a>();</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classripple_1_1Resource_1_1Consumer.html#a9cf4227f9e9d777f68a87566c7c55a1b"> 91</a></span>  <a class="code" href="classripple_1_1Resource_1_1Logic.html">Logic</a>* <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a9cf4227f9e9d777f68a87566c7c55a1b">m_logic</a>;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classripple_1_1Resource_1_1Consumer.html#a258b89dc1702add977873f92f68e2368"> 92</a></span>  <a class="code" href="structripple_1_1Resource_1_1Entry.html">Entry</a>* <a class="code" href="classripple_1_1Resource_1_1Consumer.html#a258b89dc1702add977873f92f68e2368">m_entry</a>;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a>&</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <a class="code" href="namespaceripple_1_1Resource.html#a3ffff64b06f7de442d3c4335e951e208">operator<<</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a>& os, <a class="code" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> <span class="keyword">const</span>& v);</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> } <span class="comment">// namespace Resource</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a27db21f6a4965d2ade4ba1761e3d8ccd"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a27db21f6a4965d2ade4ba1761e3d8ccd">ripple::Resource::Consumer::warn</a></div><div class="ttdeci">bool warn()</div><div class="ttdoc">Returns true if the consumer should be warned.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00110">Consumer.cpp:110</a></div></div>
|
|
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a5463a664bf34b5c191192ba4b04a9f82"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a5463a664bf34b5c191192ba4b04a9f82">ripple::Resource::Consumer::disconnect</a></div><div class="ttdeci">bool disconnect(beast::Journal const &j)</div><div class="ttdoc">Returns true if the consumer should be disconnected.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00117">Consumer.cpp:117</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a5aa9f758afee2c0944729ae1e95a782f"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a5aa9f758afee2c0944729ae1e95a782f">ripple::Resource::Consumer::entry</a></div><div class="ttdeci">Entry & entry()</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00136">Consumer.cpp:136</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_ae6ce4aef62d151f2ed8750eb79596a5a"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#ae6ce4aef62d151f2ed8750eb79596a5a">ripple::Resource::Consumer::elevate</a></div><div class="ttdeci">void elevate(std::string const &name)</div><div class="ttdoc">Raise the Consumer's privilege level to a Named endpoint.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Logic_html"><div class="ttname"><a href="classripple_1_1Resource_1_1Logic.html">ripple::Resource::Logic</a></div><div class="ttdef"><b>Definition:</b> <a href="resource_2impl_2Logic_8h_source.html#l00040">resource/impl/Logic.h:40</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_ad7cedbf4822211a1c627483b36d8a2b4"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#ad7cedbf4822211a1c627483b36d8a2b4">ripple::Resource::Consumer::disposition</a></div><div class="ttdeci">Disposition disposition() const</div><div class="ttdoc">Returns the current disposition of this consumer.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00089">Consumer.cpp:89</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Resource_html_a3ffff64b06f7de442d3c4335e951e208"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a3ffff64b06f7de442d3c4335e951e208">ripple::Resource::operator<<</a></div><div class="ttdeci">std::ostream & operator<<(std::ostream &os, Charge const &v)</div><div class="ttdef"><b>Definition:</b> <a href="Charge_8cpp_source.html#l00052">Charge.cpp:52</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a503ea58eb052215f605ede3e009df17a"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a503ea58eb052215f605ede3e009df17a">ripple::Resource::Consumer::to_string</a></div><div class="ttdeci">std::string to_string() const</div><div class="ttdoc">Return a human readable string uniquely identifying this consumer.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00071">Consumer.cpp:71</a></div></div>
|
|
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a320fc29f63c46d86d9564dcd3a3b20bb"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a320fc29f63c46d86d9564dcd3a3b20bb">ripple::Resource::Consumer::balance</a></div><div class="ttdeci">int balance()</div><div class="ttdoc">Returns the credit balance representing consumption.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00129">Consumer.cpp:129</a></div></div>
|
|
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition:</b> <a href="Journal_8h_source.html#l00058">Journal.h:58</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a258b89dc1702add977873f92f68e2368"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a258b89dc1702add977873f92f68e2368">ripple::Resource::Consumer::m_entry</a></div><div class="ttdeci">Entry * m_entry</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8h_source.html#l00092">Consumer.h:92</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1Resource_1_1Entry_html"><div class="ttname"><a href="structripple_1_1Resource_1_1Entry.html">ripple::Resource::Entry</a></div><div class="ttdef"><b>Definition:</b> <a href="Entry_8h_source.html#l00037">Entry.h:37</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html">ripple::Resource::Consumer</a></div><div class="ttdoc">An endpoint that consumes resources.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8h_source.html#l00034">Consumer.h:34</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Charge_html"><div class="ttname"><a href="classripple_1_1Resource_1_1Charge.html">ripple::Resource::Charge</a></div><div class="ttdoc">A consumption charge.</div><div class="ttdef"><b>Definition:</b> <a href="Charge_8h_source.html#l00030">Charge.h:30</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_aa196f44968e79d8c852e15ac96a71ee3"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#aa196f44968e79d8c852e15ac96a71ee3">ripple::Resource::Consumer::isUnlimited</a></div><div class="ttdeci">bool isUnlimited() const</div><div class="ttdoc">Returns true if this is a privileged endpoint.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00080">Consumer.cpp:80</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a30b81218a3be2a2a28ce2a4218f1dacf"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a30b81218a3be2a2a28ce2a4218f1dacf">ripple::Resource::Consumer::operator=</a></div><div class="ttdeci">Consumer & operator=(Consumer const &other)</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00054">Consumer.cpp:54</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1Resource_html_ae12997de115c1cf0032794aa5ea1b15d"><div class="ttname"><a href="namespaceripple_1_1Resource.html#ae12997de115c1cf0032794aa5ea1b15d">ripple::Resource::Disposition</a></div><div class="ttdeci">Disposition</div><div class="ttdoc">The disposition of a consumer after applying a load charge.</div><div class="ttdef"><b>Definition:</b> <a href="Disposition_8h_source.html#l00027">Disposition.h:27</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a65d4f295e044ae0bf1e5ef1e4e6df539"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a65d4f295e044ae0bf1e5ef1e4e6df539">ripple::Resource::Consumer::charge</a></div><div class="ttdeci">Disposition charge(Charge const &fee)</div><div class="ttdoc">Apply a load charge to the consumer.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00099">Consumer.cpp:99</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a9cf4227f9e9d777f68a87566c7c55a1b"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a9cf4227f9e9d777f68a87566c7c55a1b">ripple::Resource::Consumer::m_logic</a></div><div class="ttdeci">Logic * m_logic</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8h_source.html#l00091">Consumer.h:91</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a45943fb23e4a91f253664ef138beef5f"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a45943fb23e4a91f253664ef138beef5f">ripple::Resource::Consumer::Consumer</a></div><div class="ttdeci">Consumer()</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00033">Consumer.cpp:33</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_afb78dbde97d941cdd72a31fe573da014"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#afb78dbde97d941cdd72a31fe573da014">ripple::Resource::Consumer::~Consumer</a></div><div class="ttdeci">~Consumer()</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00047">Consumer.cpp:47</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|