160 lines
16 KiB
HTML
160 lines
16 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef UVW_POLL_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_POLL_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <uv.h></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "config.h"</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "enum.hpp"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "handle.hpp"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "util.h"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span>details {</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">enum class</span> uvw_poll_event : std::underlying_type_t<uv_poll_event> {</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> READABLE = UV_READABLE,</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> WRITABLE = UV_WRITABLE,</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> DISCONNECT = UV_DISCONNECT,</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> PRIORITIZED = UV_PRIORITIZED,</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> _UVW_ENUM = 0</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>};</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>}</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structuvw_1_1poll__event.html"> 27</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structuvw_1_1poll__event.html">poll_event</a> {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">explicit</span> <a class="code hl_struct" href="structuvw_1_1poll__event.html">poll_event</a>(details::uvw_poll_event events) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structuvw_1_1poll__event.html#a71fcdcf9db6733661cc452e483692529"> 40</a></span> details::uvw_poll_event <a class="code hl_variable" href="structuvw_1_1poll__event.html#a71fcdcf9db6733661cc452e483692529">flags</a>;</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>};</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classuvw_1_1poll__handle.html"> 59</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1poll__handle.html">poll_handle</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1handle.html">handle</a><poll_handle, uv_poll_t, poll_event> {</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">static</span> <span class="keywordtype">void</span> start_callback(uv_poll_t *hndl, <span class="keywordtype">int</span> status, <span class="keywordtype">int</span> events);</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">using </span>poll_event_flags = details::uvw_poll_event;</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classuvw_1_1poll__handle.html">poll_handle</a>(loop::token token, std::shared_ptr<loop> ref, <span class="keywordtype">int</span> desc);</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classuvw_1_1poll__handle.html">poll_handle</a>(loop::token token, std::shared_ptr<loop> ref, <a class="code hl_typedef" href="namespaceuvw.html#aa64a7948231fbdec46df43be0c24f806">os_socket_handle</a> sock);</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classuvw_1_1poll__handle.html#a893b729e6123d24f8ac8bb24670a3b64"> 72</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1poll__handle.html#a893b729e6123d24f8ac8bb24670a3b64">init</a>() final;</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classuvw_1_1poll__handle.html#a33d1a81a148e1728c28d6fe59fd4a276"> 93</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1poll__handle.html#a33d1a81a148e1728c28d6fe59fd4a276">start</a>(poll_event_flags flags);</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classuvw_1_1poll__handle.html#a917f6bc19f8e50fb2bf62ce5e28b80f7"> 99</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1poll__handle.html#a917f6bc19f8e50fb2bf62ce5e28b80f7">stop</a>();</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>private:</div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> enum {</div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> FD,</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> SOCKET</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> } tag;</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">union </span>{</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">int</span> file_desc;</div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <a class="code hl_typedef" href="namespaceuvw.html#aa64a7948231fbdec46df43be0c24f806">os_socket_handle</a> socket;</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> };</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span>};</div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span>} <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="preprocessor"># include "poll.cpp"</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="preprocessor">#endif </span><span class="comment">// UVW_POLL_INCLUDE_H</span></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#l00023">handle.hpp:23</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1poll__handle_html"><div class="ttname"><a href="classuvw_1_1poll__handle.html">uvw::poll_handle</a></div><div class="ttdoc">The poll handle.</div><div class="ttdef"><b>Definition:</b> <a href="poll_8h_source.html#l00059">poll.h:59</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1poll__handle_html_a33d1a81a148e1728c28d6fe59fd4a276"><div class="ttname"><a href="classuvw_1_1poll__handle.html#a33d1a81a148e1728c28d6fe59fd4a276">uvw::poll_handle::start</a></div><div class="ttdeci">int start(poll_event_flags flags)</div><div class="ttdoc">Starts polling the file descriptor.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1poll__handle_html_a893b729e6123d24f8ac8bb24670a3b64"><div class="ttname"><a href="classuvw_1_1poll__handle.html#a893b729e6123d24f8ac8bb24670a3b64">uvw::poll_handle::init</a></div><div class="ttdeci">int init() final</div><div class="ttdoc">Initializes the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1poll__handle_html_a917f6bc19f8e50fb2bf62ce5e28b80f7"><div class="ttname"><a href="classuvw_1_1poll__handle.html#a917f6bc19f8e50fb2bf62ce5e28b80f7">uvw::poll_handle::stop</a></div><div class="ttdeci">int stop()</div><div class="ttdoc">Stops polling the file descriptor.</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#l00008">async.h:8</a></div></div>
|
|
<div class="ttc" id="anamespaceuvw_html_aa64a7948231fbdec46df43be0c24f806"><div class="ttname"><a href="namespaceuvw.html#aa64a7948231fbdec46df43be0c24f806">uvw::os_socket_handle</a></div><div class="ttdeci">details::uv_type_wrapper< uv_os_sock_t > os_socket_handle</div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00086">util.h:86</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1poll__event_html"><div class="ttname"><a href="structuvw_1_1poll__event.html">uvw::poll_event</a></div><div class="ttdoc">Poll event.</div><div class="ttdef"><b>Definition:</b> <a href="poll_8h_source.html#l00027">poll.h:27</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1poll__event_html_a71fcdcf9db6733661cc452e483692529"><div class="ttname"><a href="structuvw_1_1poll__event.html#a71fcdcf9db6733661cc452e483692529">uvw::poll_event::flags</a></div><div class="ttdeci">details::uvw_poll_event flags</div><div class="ttdoc">Detected events all in one.</div><div class="ttdef"><b>Definition:</b> <a href="poll_8h_source.html#l00040">poll.h:40</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|