<!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_limited_layer.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_limited_layer.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="rate__limited__layer_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_LIMITED_LAYER_HEADER</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIBFILEZILLA_RATE_LIMITED_LAYER_HEADER</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="rate__limiter_8hpp.html">rate_limiter.hpp</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="socket_8hpp.html">socket.hpp</a>"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespacefz.html">fz</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classfz_1_1rate__limited__layer.html"> 18</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1rate__limited__layer.html">rate_limited_layer</a> final : <span class="keyword">public</span> <a class="code" href="classfz_1_1socket__layer.html">socket_layer</a>, <span class="keyword">private</span> <a class="code" href="classfz_1_1bucket.html">bucket</a></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="keyword">public</span>:</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <a class="code" href="classfz_1_1rate__limited__layer.html">rate_limited_layer</a>(<a class="code" href="classfz_1_1event__handler.html">event_handler</a>* handler, <a class="code" href="classfz_1_1socket__interface.html">socket_interface</a>& next_layer, <a class="code" href="classfz_1_1rate__limiter.html">rate_limiter</a> * limiter = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfz_1_1rate__limited__layer.html">rate_limited_layer</a>();</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>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="namespacefz.html#ace3cb7cda8b1407217324441cac9339faecae13117d6f0584c25a9da6c8f8415e">read</a>(<span class="keywordtype">void</span>* <a class="code" href="classfz_1_1buffer.html">buffer</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">int</span>& error) <span class="keyword">override</span>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="namespacefz.html#ace3cb7cda8b1407217324441cac9339faefb2a684e4afb7d55e6147fbe5a332ee">write</a>(<span class="keywordtype">void</span> <span class="keyword">const</span>* <a class="code" href="classfz_1_1buffer.html">buffer</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">int</span>& error) <span class="keyword">override</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">virtual</span> <a class="code" href="namespacefz.html#a4a055720116545d1fd52227e417488f8">socket_state</a> get_state()<span class="keyword"> const override </span>{</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">return</span> next_layer_.get_state();</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> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> connect(<a class="code" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> <span class="keyword">const</span>& host, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> port, address_type family = address_type::unknown)<span class="keyword"> override </span>{</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> next_layer_.connect(host, port, family);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classfz_1_1rate__limited__layer.html#a174a7c340d661c7e5b79b5b66dcb1f41"> 35</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classfz_1_1rate__limited__layer.html#a174a7c340d661c7e5b79b5b66dcb1f41">shutdown</a>()<span class="keyword"> override </span>{</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">return</span> next_layer_.shutdown();</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classfz_1_1rate__limited__layer.html#afeb59dd88cc019314f508aac23ee2145"> 39</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfz_1_1rate__limited__layer.html#afeb59dd88cc019314f508aac23ee2145">set_event_handler</a>(<a class="code" href="classfz_1_1event__handler.html">event_handler</a>* handler)<span class="keyword"> override </span>{</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classfz_1_1scoped__lock.html">scoped_lock</a> l(mtx_);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classfz_1_1socket__layer.html#afeb59dd88cc019314f508aac23ee2145">socket_layer::set_event_handler</a>(handler);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> wakeup(direction::type d) <span class="keyword">override</span>;</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> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classfz_1_1rate__limited__layer_html_a174a7c340d661c7e5b79b5b66dcb1f41"><div class="ttname"><a href="classfz_1_1rate__limited__layer.html#a174a7c340d661c7e5b79b5b66dcb1f41">fz::rate_limited_layer::shutdown</a></div><div class="ttdeci">virtual int shutdown() override</div><div class="ttdoc">Signals peers that we want to close the connections.</div><div class="ttdef"><b>Definition:</b> rate_limited_layer.hpp:35</div></div> <div class="ttc" id="classfz_1_1scoped__lock_html"><div class="ttname"><a href="classfz_1_1scoped__lock.html">fz::scoped_lock</a></div><div class="ttdoc">A simple scoped lock.</div><div class="ttdef"><b>Definition:</b> mutex.hpp:64</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_1socket__interface_html"><div class="ttname"><a href="classfz_1_1socket__interface.html">fz::socket_interface</a></div><div class="ttdoc">Interface for sockets.</div><div class="ttdef"><b>Definition:</b> socket.hpp:337</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="namespacefz_html_ace3cb7cda8b1407217324441cac9339faefb2a684e4afb7d55e6147fbe5a332ee"><div class="ttname"><a href="namespacefz.html#ace3cb7cda8b1407217324441cac9339faefb2a684e4afb7d55e6147fbe5a332ee">fz::socket_event_flag::write</a></div></div> <div class="ttc" id="classfz_1_1rate__limited__layer_html_afeb59dd88cc019314f508aac23ee2145"><div class="ttname"><a href="classfz_1_1rate__limited__layer.html#afeb59dd88cc019314f508aac23ee2145">fz::rate_limited_layer::set_event_handler</a></div><div class="ttdeci">virtual void set_event_handler(event_handler *handler) override</div><div class="ttdoc">The handler for any events generated (or forwarded) by this layer.</div><div class="ttdef"><b>Definition:</b> rate_limited_layer.hpp:39</div></div> <div class="ttc" id="rate__limiter_8hpp_html"><div class="ttname"><a href="rate__limiter_8hpp.html">rate_limiter.hpp</a></div><div class="ttdoc">Classes for rate-limiting.</div></div> <div class="ttc" id="socket_8hpp_html"><div class="ttname"><a href="socket_8hpp.html">socket.hpp</a></div><div class="ttdoc">Socket classes for networking.</div></div> <div class="ttc" id="classfz_1_1socket__layer_html"><div class="ttname"><a href="classfz_1_1socket__layer.html">fz::socket_layer</a></div><div class="ttdoc">A base class for socket layers.</div><div class="ttdef"><b>Definition:</b> socket.hpp:540</div></div> <div class="ttc" id="namespacefz_html_a79dcecd35ee9a55ae1a5afe76d23e9e5"><div class="ttname"><a href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">fz::native_string</a></div><div class="ttdeci">std::wstring native_string</div><div class="ttdoc">A string in the system's native character type and encoding. Note: This typedef changes depending on...</div><div class="ttdef"><b>Definition:</b> string.hpp:33</div></div> <div class="ttc" id="namespacefz_html_a4a055720116545d1fd52227e417488f8"><div class="ttname"><a href="namespacefz.html#a4a055720116545d1fd52227e417488f8">fz::socket_state</a></div><div class="ttdeci">socket_state</div><div class="ttdoc">State transitions are monotonically increasing.</div><div class="ttdef"><b>Definition:</b> socket.hpp:305</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="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_1rate__limited__layer_html"><div class="ttname"><a href="classfz_1_1rate__limited__layer.html">fz::rate_limited_layer</a></div><div class="ttdoc">A rate-limited socket layer.</div><div class="ttdef"><b>Definition:</b> rate_limited_layer.hpp:18</div></div> <div class="ttc" id="classfz_1_1socket__layer_html_afeb59dd88cc019314f508aac23ee2145"><div class="ttname"><a href="classfz_1_1socket__layer.html#afeb59dd88cc019314f508aac23ee2145">fz::socket_layer::set_event_handler</a></div><div class="ttdeci">virtual void set_event_handler(event_handler *handler) override</div><div class="ttdoc">The handler for any events generated (or forwarded) by this layer.</div></div> <div class="ttc" id="classfz_1_1buffer_html"><div class="ttname"><a href="classfz_1_1buffer.html">fz::buffer</a></div><div class="ttdoc">The buffer class is a simple buffer where data can be appended at the end and consumed at the front....</div><div class="ttdef"><b>Definition:</b> buffer.hpp:23</div></div> <div class="ttc" id="namespacefz_html_ace3cb7cda8b1407217324441cac9339faecae13117d6f0584c25a9da6c8f8415e"><div class="ttname"><a href="namespacefz.html#ace3cb7cda8b1407217324441cac9339faecae13117d6f0584c25a9da6c8f8415e">fz::socket_event_flag::read</a></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>