<!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: event_loop.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">event_loop.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="event__loop_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_EVENT_LOOP_HEADER</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIBFILEZILLA_EVENT_LOOP_HEADER</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="apply_8hpp.html">apply.hpp</a>"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "<a class="code" href="event_8hpp.html">event.hpp</a>"</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "<a class="code" href="mutex_8hpp.html">mutex.hpp</a>"</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="time_8hpp.html">time.hpp</a>"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="thread_8hpp.html">thread.hpp</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <deque></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span><a class="code" href="namespacefz.html">fz</a> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">class </span>async_task;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">class </span>event_handler;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">class </span>thread_pool;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classfz_1_1event__loop.html"> 33</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1event__loop.html">event_loop</a> final</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">typedef</span> std::deque<std::pair<event_handler*, event_base*>> Events;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classfz_1_1event__loop.html">event_loop</a>();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1event__loop.html">event_loop</a>(<a class="code" href="classfz_1_1thread__pool.html">thread_pool</a> & pool);</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">enum</span> loop_option</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  threadless</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>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1event__loop.html">event_loop</a>(loop_option);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ~<a class="code" href="classfz_1_1event__loop.html">event_loop</a>();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classfz_1_1event__loop.html">event_loop</a>(<a class="code" href="classfz_1_1event__loop.html">event_loop</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classfz_1_1event__loop.html">event_loop</a>& operator=(<a class="code" href="classfz_1_1event__loop.html">event_loop</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> filter_events(std::function<<span class="keywordtype">bool</span> (Events::value_type&)> <span class="keyword">const</span>& filter);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> stop(<span class="keywordtype">bool</span> join = <span class="keyword">false</span>);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> run();</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classfz_1_1event__handler.html">event_handler</a>;</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>  <span class="keywordtype">void</span> FZ_PRIVATE_SYMBOL remove_handler(<a class="code" href="classfz_1_1event__handler.html">event_handler</a>* handler);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  timer_id FZ_PRIVATE_SYMBOL add_timer(<a class="code" href="classfz_1_1event__handler.html">event_handler</a>* handler, <a class="code" href="classfz_1_1duration.html">duration</a> <span class="keyword">const</span>& interval, <span class="keywordtype">bool</span> one_shot);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">void</span> FZ_PRIVATE_SYMBOL stop_timer(timer_id <span class="keywordtype">id</span>);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> send_event(<a class="code" href="classfz_1_1event__handler.html">event_handler</a>* handler, <a class="code" href="classfz_1_1event__base.html">event_base</a>* evt);</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="comment">// Process the next (if any) event. Returns true if an event has been processed</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">bool</span> FZ_PRIVATE_SYMBOL process_event(<a class="code" href="classfz_1_1scoped__lock.html">scoped_lock</a> & l);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// Process timers. Returns true if a timer has been triggered</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">bool</span> FZ_PRIVATE_SYMBOL process_timers(<a class="code" href="classfz_1_1scoped__lock.html">scoped_lock</a> & l, <a class="code" href="classfz_1_1monotonic__clock.html">monotonic_clock</a>& now);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> FZ_PRIVATE_SYMBOL entry();</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="keyword">struct </span>FZ_PRIVATE_SYMBOL timer_data final</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="classfz_1_1event__handler.html">event_handler</a>* handler_{};</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  timer_id id_{};</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classfz_1_1monotonic__clock.html">monotonic_clock</a> deadline_;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="classfz_1_1duration.html">duration</a> interval_{};</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  };</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">typedef</span> std::vector<timer_data> Timers;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  Events pending_events_;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  Timers timers_;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classfz_1_1mutex.html">mutex</a> sync_;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classfz_1_1condition.html">condition</a> cond_;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">bool</span> quit_{};</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="classfz_1_1event__handler.html">event_handler</a> * active_handler_{};</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="classfz_1_1monotonic__clock.html">monotonic_clock</a> deadline_;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  timer_id next_timer_id_{};</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  thread::id thread_id_{};</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  std::unique_ptr<thread> thread_;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  std::unique_ptr<async_task> task_;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> };</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="mutex_8hpp_html"><div class="ttname"><a href="mutex_8hpp.html">mutex.hpp</a></div><div class="ttdoc">Thread synchronization primitives: mutex, scoped_lock and condition.</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_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="classfz_1_1condition_html"><div class="ttname"><a href="classfz_1_1condition.html">fz::condition</a></div><div class="ttdoc">Waitable condition variable.</div><div class="ttdef"><b>Definition:</b> mutex.hpp:154</div></div> <div class="ttc" id="time_8hpp_html"><div class="ttname"><a href="time_8hpp.html">time.hpp</a></div><div class="ttdoc">Assorted classes dealing with time.</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="thread_8hpp_html"><div class="ttname"><a href="thread_8hpp.html">thread.hpp</a></div><div class="ttdoc">Declares thread.</div></div> <div class="ttc" id="classfz_1_1monotonic__clock_html"><div class="ttname"><a href="classfz_1_1monotonic__clock.html">fz::monotonic_clock</a></div><div class="ttdoc">A monotonic clock (aka steady clock) is independent from walltime.</div><div class="ttdef"><b>Definition:</b> time.hpp:368</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_1duration_html"><div class="ttname"><a href="classfz_1_1duration.html">fz::duration</a></div><div class="ttdoc">The duration class represents a time interval in milliseconds.</div><div class="ttdef"><b>Definition:</b> time.hpp:271</div></div> <div class="ttc" id="event_8hpp_html"><div class="ttname"><a href="event_8hpp.html">event.hpp</a></div><div class="ttdoc">Declares event_base and simple_event<></div></div> <div class="ttc" id="apply_8hpp_html"><div class="ttname"><a href="apply_8hpp.html">apply.hpp</a></div><div class="ttdoc">Template helper to call a function with its arguments extracted from a tuple.</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_1thread__pool_html"><div class="ttname"><a href="classfz_1_1thread__pool.html">fz::thread_pool</a></div><div class="ttdef"><b>Definition:</b> thread_pool.hpp:59</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>