161 lines
15 KiB
HTML
161 lines
15 KiB
HTML
<!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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: src/uvw/poll.h 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
|
|
 <span id="projectnumber">2.6.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<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_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.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef UVW_POLL_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define UVW_POLL_INCLUDE_H</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>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "handle.hpp"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "util.h"</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>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <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>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span>details {</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>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">enum class</span> UVPollEvent: std::underlying_type_t<uv_poll_event> {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  READABLE = UV_READABLE,</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  WRITABLE = UV_WRITABLE,</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  DISCONNECT = UV_DISCONNECT,</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  PRIORITIZED = UV_PRIORITIZED</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> }</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structuvw_1_1PollEvent.html"> 34</a></span> <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>  <span class="keyword">explicit</span> <a class="code" href="structuvw_1_1PollEvent.html">PollEvent</a>(<a class="code" href="classuvw_1_1Flags.html">Flags<details::UVPollEvent></a> events) noexcept;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structuvw_1_1PollEvent.html#ac3d9842783aeb5e923e1b3bc12d81611"> 47</a></span>  <a class="code" href="classuvw_1_1Flags.html">Flags<details::UVPollEvent></a> <a class="code" href="structuvw_1_1PollEvent.html#ac3d9842783aeb5e923e1b3bc12d81611">flags</a>;</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>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classuvw_1_1PollHandle.html"> 67</a></span> <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><PollHandle, uv_poll_t> {</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <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="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">using</span> Event = details::UVPollEvent;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">explicit</span> <a class="code" href="classuvw_1_1PollHandle.html">PollHandle</a>(ConstructorAccess ca, std::shared_ptr<Loop> ref, <span class="keywordtype">int</span> desc);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">explicit</span> <a class="code" href="classuvw_1_1PollHandle.html">PollHandle</a>(ConstructorAccess ca, std::shared_ptr<Loop> ref, <a class="code" href="namespaceuvw.html#a2df38e5bba10fc959ef37074cf580097">OSSocketHandle</a> sock);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1PollHandle.html#a83932cfaa67ddf181a420852b2b097bc">init</a>();</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <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<Event></a> flags);</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PollHandle.html#acaace783e58bddca6546d44a00b4203a">start</a>(Event event);</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1PollHandle.html#a298ef392a0aed41e16293d3df931f210">stop</a>();</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="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">enum</span> { FD, SOCKET } tag;</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">union </span>{</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">int</span> fd;</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  OSSocketHandle::Type socket;</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  };</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> };</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> }</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  </div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#include "poll.cpp"</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif // UVW_POLL_INCLUDE_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassuvw_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_8h_source.html#l00067">poll.h:67</a></div></div>
|
|
<div class="ttc" id="anamespaceuvw_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_8h_source.html#l00010">async.h:10</a></div></div>
|
|
<div class="ttc" id="aclassuvw_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>
|
|
<div class="ttc" id="aclassuvw_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>
|
|
<div class="ttc" id="aclassuvw_1_1Flags_html"><div class="ttname"><a href="classuvw_1_1Flags.html">uvw::Flags< details::UVPollEvent ></a></div></div>
|
|
<div class="ttc" id="aclassuvw_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#l00030">handle.hpp:30</a></div></div>
|
|
<div class="ttc" id="aclassuvw_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< Event > flags)</div><div class="ttdoc">Starts polling the file descriptor.</div></div>
|
|
<div class="ttc" id="astructuvw_1_1PollEvent_html_ac3d9842783aeb5e923e1b3bc12d81611"><div class="ttname"><a href="structuvw_1_1PollEvent.html#ac3d9842783aeb5e923e1b3bc12d81611">uvw::PollEvent::flags</a></div><div class="ttdeci">Flags< details::UVPollEvent > flags</div><div class="ttdoc">Detected events all in one.</div><div class="ttdef"><b>Definition:</b> <a href="poll_8h_source.html#l00047">poll.h:47</a></div></div>
|
|
<div class="ttc" id="anamespaceuvw_html_a2df38e5bba10fc959ef37074cf580097"><div class="ttname"><a href="namespaceuvw.html#a2df38e5bba10fc959ef37074cf580097">uvw::OSSocketHandle</a></div><div class="ttdeci">details::UVTypeWrapper< uv_os_sock_t > OSSocketHandle</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00190">util.h:190</a></div></div>
|
|
<div class="ttc" id="astructuvw_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_8h_source.html#l00034">poll.h:34</a></div></div>
|
|
<!-- 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.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|