uvw/poll_8hpp_source.html
2017-10-11 09:11:53 +02:00

91 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: src/uvw/poll.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uvw
&#160;<span id="projectnumber">1.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_98934c98f70735fe3a272005a9eb8736.html">uvw</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">poll.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;uv.h&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;handle.hpp&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;util.hpp&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceuvw.html">uvw</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">namespace </span>details {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">enum class</span> UVPollEvent: std::underlying_type_t&lt;uv_poll_event&gt; {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; READABLE = UV_READABLE,</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; WRITABLE = UV_WRITABLE,</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; DISCONNECT = UV_DISCONNECT,</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; PRIORITIZED = UV_PRIORITIZED</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;};</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;}</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structuvw_1_1PollEvent.html"> 34</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structuvw_1_1PollEvent.html">PollEvent</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">explicit</span> <a class="code" href="structuvw_1_1PollEvent.html">PollEvent</a>(<a class="code" href="classuvw_1_1Flags.html">Flags&lt;details::UVPollEvent&gt;</a> events) noexcept</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; : flags{std::move(events)}</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {}</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structuvw_1_1PollEvent.html#ac3d9842783aeb5e923e1b3bc12d81611"> 49</a></span>&#160; <a class="code" href="classuvw_1_1Flags.html">Flags&lt;details::UVPollEvent&gt;</a> <a class="code" href="structuvw_1_1PollEvent.html#ac3d9842783aeb5e923e1b3bc12d81611">flags</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;};</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classuvw_1_1PollHandle.html"> 69</a></span>&#160;<span class="keyword">class </span><a class="code" href="classuvw_1_1PollHandle.html">PollHandle</a> final: <span class="keyword">public</span> <a class="code" href="classuvw_1_1Handle.html">Handle</a>&lt;PollHandle, uv_poll_t&gt; {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> startCallback(uv_poll_t *handle, <span class="keywordtype">int</span> status, <span class="keywordtype">int</span> events) {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="classuvw_1_1PollHandle.html">PollHandle</a> &amp;poll = *(<span class="keyword">static_cast&lt;</span><a class="code" href="classuvw_1_1PollHandle.html">PollHandle</a>*<span class="keyword">&gt;</span>(handle-&gt;data));</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">if</span>(status) { poll.publish(<a class="code" href="structuvw_1_1ErrorEvent.html">ErrorEvent</a>{status}); }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">else</span> { poll.publish(<a class="code" href="structuvw_1_1PollEvent.html">PollEvent</a>{<span class="keyword">static_cast&lt;</span>std::underlying_type_t&lt;Event&gt;<span class="keyword">&gt;</span>(events)}); }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">using</span> Event = details::UVPollEvent;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classuvw_1_1PollHandle.html">PollHandle</a>(ConstructorAccess ca, std::shared_ptr&lt;Loop&gt; ref, <span class="keywordtype">int</span> desc)</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; : <a class="code" href="classuvw_1_1Handle.html">Handle</a>{ca, std::move(ref)}, tag{FD}, fd{desc}</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; {}</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classuvw_1_1PollHandle.html">PollHandle</a>(ConstructorAccess ca, std::shared_ptr&lt;Loop&gt; ref, <a class="code" href="namespaceuvw.html#a2df38e5bba10fc959ef37074cf580097">OSSocketHandle</a> sock)</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; : <a class="code" href="classuvw_1_1Handle.html">Handle</a>{ca, std::move(ref)}, tag{SOCKET}, socket{sock}</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; {}</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classuvw_1_1PollHandle.html#a83932cfaa67ddf181a420852b2b097bc"> 91</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1PollHandle.html#a83932cfaa67ddf181a420852b2b097bc">init</a>() {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> (tag == SOCKET)</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; ? initialize(&amp;uv_poll_init_socket, socket)</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; : initialize(&amp;uv_poll_init, fd);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classuvw_1_1PollHandle.html#acaace783e58bddca6546d44a00b4203a"> 116</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PollHandle.html#acaace783e58bddca6546d44a00b4203a">start</a>(<a class="code" href="classuvw_1_1Flags.html">Flags&lt;Event&gt;</a> flags) {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; invoke(&amp;uv_poll_start, <span class="keyword">get</span>(), flags, &amp;startCallback);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="classuvw_1_1PollHandle.html#a261240bf912cdc15c40cdf3e5472ce6a"> 139</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PollHandle.html#a261240bf912cdc15c40cdf3e5472ce6a">start</a>(Event event) {</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; start(<a class="code" href="classuvw_1_1Flags.html">Flags&lt;Event&gt;</a>{<span class="keyword">event</span>});</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; }</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div><div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="classuvw_1_1PollHandle.html#a298ef392a0aed41e16293d3df931f210"> 146</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PollHandle.html#a298ef392a0aed41e16293d3df931f210">stop</a>() {</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; invoke(&amp;uv_poll_stop, <span class="keyword">get</span>());</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; }</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">enum</span> { FD, SOCKET } tag;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keyword">union </span>{</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordtype">int</span> fd;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; OSSocketHandle::Type socket;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; };</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;};</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;}</div><div class="ttc" id="classuvw_1_1PollHandle_html_a83932cfaa67ddf181a420852b2b097bc"><div class="ttname"><a href="classuvw_1_1PollHandle.html#a83932cfaa67ddf181a420852b2b097bc">uvw::PollHandle::init</a></div><div class="ttdeci">bool init()</div><div class="ttdoc">Initializes the handle. </div><div class="ttdef"><b>Definition:</b> <a href="poll_8hpp_source.html#l00091">poll.hpp:91</a></div></div>
<div class="ttc" id="structuvw_1_1PollEvent_html"><div class="ttname"><a href="structuvw_1_1PollEvent.html">uvw::PollEvent</a></div><div class="ttdoc">PollEvent event. </div><div class="ttdef"><b>Definition:</b> <a href="poll_8hpp_source.html#l00034">poll.hpp:34</a></div></div>
<div class="ttc" id="classuvw_1_1Flags_html"><div class="ttname"><a href="classuvw_1_1Flags.html">uvw::Flags&lt; details::UVPollEvent &gt;</a></div></div>
<div class="ttc" id="classuvw_1_1Handle_html"><div class="ttname"><a href="classuvw_1_1Handle.html">uvw::Handle</a></div><div class="ttdoc">Handle base class. </div><div class="ttdef"><b>Definition:</b> <a href="handle_8hpp_source.html#l00029">handle.hpp:29</a></div></div>
<div class="ttc" id="classuvw_1_1PollHandle_html"><div class="ttname"><a href="classuvw_1_1PollHandle.html">uvw::PollHandle</a></div><div class="ttdoc">The PollHandle handle. </div><div class="ttdef"><b>Definition:</b> <a href="poll_8hpp_source.html#l00069">poll.hpp:69</a></div></div>
<div class="ttc" id="classuvw_1_1PollHandle_html_a298ef392a0aed41e16293d3df931f210"><div class="ttname"><a href="classuvw_1_1PollHandle.html#a298ef392a0aed41e16293d3df931f210">uvw::PollHandle::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Stops polling the file descriptor. </div><div class="ttdef"><b>Definition:</b> <a href="poll_8hpp_source.html#l00146">poll.hpp:146</a></div></div>
<div class="ttc" id="classuvw_1_1PollHandle_html_acaace783e58bddca6546d44a00b4203a"><div class="ttname"><a href="classuvw_1_1PollHandle.html#acaace783e58bddca6546d44a00b4203a">uvw::PollHandle::start</a></div><div class="ttdeci">void start(Flags&lt; Event &gt; flags)</div><div class="ttdoc">Starts polling the file descriptor. </div><div class="ttdef"><b>Definition:</b> <a href="poll_8hpp_source.html#l00116">poll.hpp:116</a></div></div>
<div class="ttc" id="structuvw_1_1ErrorEvent_html"><div class="ttname"><a href="structuvw_1_1ErrorEvent.html">uvw::ErrorEvent</a></div><div class="ttdoc">The ErrorEvent event. </div><div class="ttdef"><b>Definition:</b> <a href="emitter_8hpp_source.html#l00023">emitter.hpp:23</a></div></div>
<div class="ttc" id="namespaceuvw_html_a2df38e5bba10fc959ef37074cf580097"><div class="ttname"><a href="namespaceuvw.html#a2df38e5bba10fc959ef37074cf580097">uvw::OSSocketHandle</a></div><div class="ttdeci">details::UVTypeWrapper&lt; uv_os_sock_t &gt; OSSocketHandle</div><div class="ttdef"><b>Definition:</b> <a href="util_8hpp_source.html#l00187">util.hpp:187</a></div></div>
<div class="ttc" id="classuvw_1_1PollHandle_html_a261240bf912cdc15c40cdf3e5472ce6a"><div class="ttname"><a href="classuvw_1_1PollHandle.html#a261240bf912cdc15c40cdf3e5472ce6a">uvw::PollHandle::start</a></div><div class="ttdeci">void start(Event event)</div><div class="ttdoc">Starts polling the file descriptor. </div><div class="ttdef"><b>Definition:</b> <a href="poll_8hpp_source.html#l00139">poll.hpp:139</a></div></div>
<div class="ttc" id="structuvw_1_1PollEvent_html_ac3d9842783aeb5e923e1b3bc12d81611"><div class="ttname"><a href="structuvw_1_1PollEvent.html#ac3d9842783aeb5e923e1b3bc12d81611">uvw::PollEvent::flags</a></div><div class="ttdeci">Flags&lt; details::UVPollEvent &gt; flags</div><div class="ttdoc">Detected events all in one. </div><div class="ttdef"><b>Definition:</b> <a href="poll_8hpp_source.html#l00049">poll.hpp:49</a></div></div>
<div class="ttc" id="namespaceuvw_html"><div class="ttname"><a href="namespaceuvw.html">uvw</a></div><div class="ttdoc">uvw default namespace. </div><div class="ttdef"><b>Definition:</b> <a href="async_8hpp_source.html#l00011">async.hpp:11</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>