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

deploy: 2406b28e64

Browse Source
This commit is contained in:
bthomee
2025-03-11 18:21:06 +00:00
parent 95e4a9d650
commit 4ba075f689
2527 changed files with 275798 additions and 275583 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Consumer_8h_source.html
View File

@@ -163,25 +163,25 @@ $(function() {
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="preprocessor">#endif</span></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>
<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>
<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:59</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#l00059">Journal.h:60</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:31</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:35</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="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="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 &amp; operator=(Consumer const &amp;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="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#l00130">Consumer.cpp:130</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_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="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 &amp;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 &amp; entry()</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00138">Consumer.cpp:138</a></div></div>
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a935e83cb32adf14651d2256783ad81d9"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a935e83cb32adf14651d2256783ad81d9">ripple::Resource::Consumer::charge</a></div><div class="ttdeci">Disposition charge(Charge const &amp;fee, std::string const &amp;context={})</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_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#l00117">Consumer.cpp:117</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 &amp; operator=(Consumer const &amp;other)</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00061">Consumer.cpp:61</a></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#l00137">Consumer.cpp:137</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#l00040">Consumer.cpp:40</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#l00078">Consumer.cpp:78</a></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 &amp;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#l00124">Consumer.cpp:124</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 &amp; entry()</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00145">Consumer.cpp:145</a></div></div>
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html_a935e83cb32adf14651d2256783ad81d9"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html#a935e83cb32adf14651d2256783ad81d9">ripple::Resource::Consumer::charge</a></div><div class="ttdeci">Disposition charge(Charge const &amp;fee, std::string const &amp;context={})</div><div class="ttdoc">Apply a load charge to the consumer.</div><div class="ttdef"><b>Definition:</b> <a href="Consumer_8cpp_source.html#l00106">Consumer.cpp:106</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_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_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="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#l00087">Consumer.cpp:87</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#l00096">Consumer.cpp:96</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 &amp;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_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>
<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="include_2xrpl_2resource_2detail_2Logic_8h_source.html#l00040">include/xrpl/resource/detail/Logic.h:41</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&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, Charge const &amp;v)</div><div class="ttdef"><b>Definition:</b> <a href="Charge_8cpp_source.html#l00051">Charge.cpp:52</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#l00054">Consumer.cpp:54</a></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="include_2xrpl_2resource_2detail_2Logic_8h_source.html#l00041">include/xrpl/resource/detail/Logic.h:42</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&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, Charge const &amp;v)</div><div class="ttdef"><b>Definition:</b> <a href="Charge_8cpp_source.html#l00055">Charge.cpp:56</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="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="algorithm_8h_source.html#l00026">algorithm.h:26</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:38</a></div></div>