<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfilezilla: rate_limiter.hpp 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="projectlogo"><img alt="Logo" src="libfilezilla.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfilezilla
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_bfd4f94fea6b65a4615f91ddf59adbf8.html">libfilezilla</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">rate_limiter.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="rate__limiter_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef LIBFILEZILLA_RATE_LIMITER_HEADER</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIBFILEZILLA_RATE_LIMITER_HEADER</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="event__handler_8hpp.html">event_handler.hpp</a>"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span><a class="code" href="namespacefz.html">fz</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>rate {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">using</span> <a class="code" href="logger_8hpp.html#a6a45d16d760a1ff1e55a84070b48aca0">type</a> = uint64_t;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> enum : <a class="code" href="logger_8hpp.html#a6a45d16d760a1ff1e55a84070b48aca0">type</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  unlimited = static_cast<type>(-1)</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> };</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> }</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span>direction {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">enum</span> <a class="code" href="logger_8hpp.html#a6a45d16d760a1ff1e55a84070b48aca0">type</a> : <span class="keywordtype">size_t</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  inbound,</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  outbound</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> };</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>rate_limiter;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classfz_1_1rate__limit__manager.html"> 45</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1rate__limit__manager.html">rate_limit_manager</a> final : <span class="keyword">public</span> <a class="code" href="classfz_1_1event__handler.html">event_handler</a></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1rate__limit__manager.html">rate_limit_manager</a>(<a class="code" href="classfz_1_1event__loop.html">event_loop</a> & loop);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfz_1_1rate__limit__manager.html">rate_limit_manager</a>();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> add(<a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a>* limiter);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> set_burst_tolerance(rate::type tolerance);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classfz_1_1bucket__base.html">bucket_base</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classfz_1_1bucket.html">bucket</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> record_activity();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> operator()(<a class="code" href="classfz_1_1event__base.html">event_base</a> <span class="keyword">const</span>& ev);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> on_timer(timer_id <span class="keyword">const</span>&);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> <a class="code" href="classfz_1_1process.html">process</a>(<a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a>* limiter, <span class="keywordtype">bool</span> locked);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classfz_1_1mutex.html">mutex</a> mtx_{<span class="keyword">false</span>};</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  std::vector<rate_limiter*> limiters_;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::atomic<timer_id> timer_{};</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::atomic<int> activity_{2};</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  std::atomic<rate::type> burst_tolerance_{1};</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> };</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classfz_1_1bucket__base.html"> 85</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1bucket__base.html">bucket_base</a></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfz_1_1bucket__base.html">bucket_base</a>() noexcept = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> remove_bucket();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classfz_1_1bucket__base.html#ae9e64735cf9b1daa7d68685f8207db54"> 105</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfz_1_1bucket__base.html#ae9e64735cf9b1daa7d68685f8207db54">lock_tree</a>() { mtx_.lock(); }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> update_stats(<span class="keywordtype">bool</span> & active) = 0;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classfz_1_1bucket__base.html#a2f4283d47fb7cade9295c964409daee1"> 119</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classfz_1_1bucket__base.html#a2f4283d47fb7cade9295c964409daee1">weight</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classfz_1_1bucket__base.html#ac7e096cae1f355684e595efaeee1ce13"> 126</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classfz_1_1bucket__base.html#ac7e096cae1f355684e595efaeee1ce13">unsaturated</a>(direction::type <span class="keyword">const</span> <span class="comment">/*d*/</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_mgr_recursive(<a class="code" href="classfz_1_1rate__limit__manager.html">rate_limit_manager</a> * mgr);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">virtual</span> rate::type add_tokens(direction::type <span class="keyword">const</span> <span class="comment">/*d*/</span>, rate::type <span class="comment">/*tokens*/</span>, rate::type <span class="comment">/*limit*/</span>) = 0;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00155"></a><span class="lineno"><a class="line" href="classfz_1_1bucket__base.html#a7c7d391eb6857e4ccd28185064be54ac"> 155</a></span>  <span class="keyword">virtual</span> rate::type <a class="code" href="classfz_1_1bucket__base.html#a7c7d391eb6857e4ccd28185064be54ac">distribute_overflow</a>(direction::type <span class="keyword">const</span> <span class="comment">/*d*/</span>, rate::type <span class="comment">/*tokens*/</span>) { <span class="keywordflow">return</span> 0; }</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classfz_1_1bucket__base.html#aff8ff3fe108112a5fe3f17f3928d3ff1"> 160</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfz_1_1bucket__base.html#aff8ff3fe108112a5fe3f17f3928d3ff1">unlock_tree</a>() { mtx_.unlock(); }</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">virtual</span> std::array<rate::type, 2> gather_unspent_for_removal() = 0;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <a class="code" href="classfz_1_1mutex.html">mutex</a> mtx_{<span class="keyword">false</span>};</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  rate_limit_manager * mgr_{};</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">void</span> * parent_{};</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordtype">size_t</span> idx_{static_cast<size_t>(-1)};</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> };</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="classfz_1_1rate__limiter.html"> 185</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a> final : <span class="keyword">public</span> <a class="code" href="classfz_1_1bucket__base.html">bucket_base</a></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> {</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a>(<a class="code" href="classfz_1_1rate__limit__manager.html">rate_limit_manager</a> * mgr);</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a>();</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keywordtype">void</span> add(<a class="code" href="classfz_1_1bucket__base.html">bucket_base</a>* <a class="code" href="classfz_1_1bucket.html">bucket</a>);</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordtype">void</span> set_limits(rate::type download_limit, rate::type upload_limit);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  rate::type limit(direction::type <span class="keyword">const</span> d);</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classfz_1_1bucket__base.html">bucket_base</a>;</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classfz_1_1rate__limit__manager.html">rate_limit_manager</a>;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> lock_tree() <span class="keyword">override</span>;</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordtype">bool</span> do_set_limit(direction::type <span class="keyword">const</span> d, rate::type limit);</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> update_stats(<span class="keywordtype">bool</span> & active) <span class="keyword">override</span>;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> weight()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> weight_; }</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> unsaturated(direction::type <span class="keyword">const</span> d)<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> data_[d].unused_capacity_ ? data_[d].unsaturated_ : 0; }</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_mgr_recursive(<a class="code" href="classfz_1_1rate__limit__manager.html">rate_limit_manager</a> * mgr) <span class="keyword">override</span>;</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">virtual</span> rate::type add_tokens(direction::type <span class="keyword">const</span> d, rate::type tokens, rate::type limit) <span class="keyword">override</span>;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keyword">virtual</span> rate::type distribute_overflow(direction::type <span class="keyword">const</span> d, rate::type tokens) <span class="keyword">override</span>;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> unlock_tree() <span class="keyword">override</span>;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keywordtype">void</span> pay_debt(direction::type <span class="keyword">const</span> d);</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keyword">virtual</span> std::array<rate::type, 2> gather_unspent_for_removal() <span class="keyword">override</span>;</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  std::vector<bucket_base*> buckets_;</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  std::vector<size_t> scratch_buffer_;</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordtype">size_t</span> weight_{};</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keyword">struct </span>data_t {</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  rate::type limit_{rate::unlimited};</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  rate::type merged_tokens_;</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  rate::type overflow_{};</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  rate::type debt_{};</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  rate::type unused_capacity_{};</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  rate::type carry_{};</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <span class="keywordtype">size_t</span> unsaturated_{};</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  } data_[2];</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> };</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00252"></a><span class="lineno"><a class="line" href="classfz_1_1bucket.html"> 252</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1bucket.html">bucket</a> : <span class="keyword">public</span> <a class="code" href="classfz_1_1bucket__base.html">bucket_base</a></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> {</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfz_1_1bucket.html">bucket</a>();</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  rate::type available(direction::type <span class="keyword">const</span> d);</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keywordtype">void</span> consume(direction::type <span class="keyword">const</span> d, rate::type amount);</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="classfz_1_1bucket.html#a853bad480b7b70568a848c8aa6d12704"> 278</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfz_1_1bucket.html#a853bad480b7b70568a848c8aa6d12704">wakeup</a>(direction::type <span class="comment">/*d*/</span>) {}</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> update_stats(<span class="keywordtype">bool</span> & active) <span class="keyword">override</span>;</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> unsaturated(direction::type <span class="keyword">const</span> d)<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> data_[d].unsaturated_ ? 1 : 0; }</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> </div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keyword">virtual</span> rate::type add_tokens(direction::type <span class="keyword">const</span> d, rate::type tokens, rate::type limit) <span class="keyword">override</span>;</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keyword">virtual</span> rate::type distribute_overflow(direction::type <span class="keyword">const</span> d, rate::type tokens) <span class="keyword">override</span>;</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> unlock_tree() <span class="keyword">override</span>;</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> </div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <span class="keyword">virtual</span> std::array<rate::type, 2> gather_unspent_for_removal() <span class="keyword">override</span>;</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keyword">struct </span>data_t {</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  rate::type available_{rate::unlimited};</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  rate::type overflow_multiplier_{1};</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  rate::type bucket_size_{rate::unlimited};</div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  <span class="keywordtype">bool</span> waiting_{};</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keywordtype">bool</span> unsaturated_{};</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  } data_[2];</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> };</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> }</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> </div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classfz_1_1bucket__base_html_a2f4283d47fb7cade9295c964409daee1"><div class="ttname"><a href="classfz_1_1bucket__base.html#a2f4283d47fb7cade9295c964409daee1">fz::bucket_base::weight</a></div><div class="ttdeci">virtual size_t weight() const</div><div class="ttdoc">Returns the weight of the tree.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:119</div></div>
<div class="ttc" id="classfz_1_1rate__limit__manager_html"><div class="ttname"><a href="classfz_1_1rate__limit__manager.html">fz::rate_limit_manager</a></div><div class="ttdoc">Context for rate_limiters.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:45</div></div>
<div class="ttc" id="classfz_1_1bucket_html"><div class="ttname"><a href="classfz_1_1bucket.html">fz::bucket</a></div><div class="ttdoc">A rate-limited token bucket.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:252</div></div>
<div class="ttc" id="classfz_1_1event__handler_html"><div class="ttname"><a href="classfz_1_1event__handler.html">fz::event_handler</a></div><div class="ttdoc">Simple handler for asynchronous event processing.</div><div class="ttdef"><b>Definition:</b> event_handler.hpp:54</div></div>
<div class="ttc" id="event__handler_8hpp_html"><div class="ttname"><a href="event__handler_8hpp.html">event_handler.hpp</a></div><div class="ttdoc">Declares the event_handler class.</div></div>
<div class="ttc" id="classfz_1_1bucket__base_html_aff8ff3fe108112a5fe3f17f3928d3ff1"><div class="ttname"><a href="classfz_1_1bucket__base.html#aff8ff3fe108112a5fe3f17f3928d3ff1">fz::bucket_base::unlock_tree</a></div><div class="ttdeci">virtual void unlock_tree()</div><div class="ttdoc">Recursively unlocks the mutexes of self and all childen.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:160</div></div>
<div class="ttc" id="classfz_1_1bucket__base_html_a7c7d391eb6857e4ccd28185064be54ac"><div class="ttname"><a href="classfz_1_1bucket__base.html#a7c7d391eb6857e4ccd28185064be54ac">fz::bucket_base::distribute_overflow</a></div><div class="ttdeci">virtual rate::type distribute_overflow(direction::type const, rate::type)</div><div class="ttdoc">Recursively distributes overflow.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:155</div></div>
<div class="ttc" id="classfz_1_1bucket_html_a853bad480b7b70568a848c8aa6d12704"><div class="ttname"><a href="classfz_1_1bucket.html#a853bad480b7b70568a848c8aa6d12704">fz::bucket::wakeup</a></div><div class="ttdeci">virtual void wakeup(direction::type)</div><div class="ttdoc">Called in response to unlock_tree if tokens have become available.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:278</div></div>
<div class="ttc" id="logger_8hpp_html_a6a45d16d760a1ff1e55a84070b48aca0"><div class="ttname"><a href="logger_8hpp.html#a6a45d16d760a1ff1e55a84070b48aca0">fz::logmsg::type</a></div><div class="ttdeci">type</div><div class="ttdef"><b>Definition:</b> logger.hpp:15</div></div>
<div class="ttc" id="classfz_1_1event__loop_html"><div class="ttname"><a href="classfz_1_1event__loop.html">fz::event_loop</a></div><div class="ttdoc">A threaded event loop that supports sending events and timers.</div><div class="ttdef"><b>Definition:</b> event_loop.hpp:33</div></div>
<div class="ttc" id="classfz_1_1rate__limiter_html"><div class="ttname"><a href="classfz_1_1rate__limiter.html">fz::rate_limiter</a></div><div class="ttdoc">A limiter for the attached buckets.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:185</div></div>
<div class="ttc" id="classfz_1_1bucket__base_html"><div class="ttname"><a href="classfz_1_1bucket__base.html">fz::bucket_base</a></div><div class="ttdoc">Base class for buckets.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:85</div></div>
<div class="ttc" id="namespacefz_html"><div class="ttname"><a href="namespacefz.html">fz</a></div><div class="ttdoc">The namespace used by libfilezilla.</div><div class="ttdef"><b>Definition:</b> apply.hpp:17</div></div>
<div class="ttc" id="classfz_1_1bucket__base_html_ac7e096cae1f355684e595efaeee1ce13"><div class="ttname"><a href="classfz_1_1bucket__base.html#ac7e096cae1f355684e595efaeee1ce13">fz::bucket_base::unsaturated</a></div><div class="ttdeci">virtual size_t unsaturated(direction::type const) const</div><div class="ttdoc">Returns the number of buckets not yet full.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:126</div></div>
<div class="ttc" id="classfz_1_1bucket__base_html_ae9e64735cf9b1daa7d68685f8207db54"><div class="ttname"><a href="classfz_1_1bucket__base.html#ae9e64735cf9b1daa7d68685f8207db54">fz::bucket_base::lock_tree</a></div><div class="ttdeci">virtual void lock_tree()</div><div class="ttdoc">Recursively locks the mutexes of self and all children.</div><div class="ttdef"><b>Definition:</b> rate_limiter.hpp:105</div></div>
<div class="ttc" id="classfz_1_1process_html"><div class="ttname"><a href="classfz_1_1process.html">fz::process</a></div><div class="ttdoc">The process class manages an asynchronous process with redirected IO.</div><div class="ttdef"><b>Definition:</b> process.hpp:21</div></div>
<div class="ttc" id="classfz_1_1mutex_html"><div class="ttname"><a href="classfz_1_1mutex.html">fz::mutex</a></div><div class="ttdoc">Lean replacement for std::(recursive_)mutex.</div><div class="ttdef"><b>Definition:</b> mutex.hpp:27</div></div>
<div class="ttc" id="classfz_1_1event__base_html"><div class="ttname"><a href="classfz_1_1event__base.html">fz::event_base</a></div><div class="ttdoc">Common base class for all events.</div><div class="ttdef"><b>Definition:</b> event.hpp:22</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
94774a05d4f99367afd97b8b4adf565d
>
files
>
545
