136 lines
13 KiB
HTML
136 lines
13 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/signal.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">signal.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_SIGNAL_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_SIGNAL_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 <uv.h></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "config.h"</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include "handle.hpp"</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "loop.h"</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="structuvw_1_1signal__event.html"> 12</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structuvw_1_1signal__event.html">signal_event</a> {</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">explicit</span> <a class="code hl_struct" href="structuvw_1_1signal__event.html">signal_event</a>(<span class="keywordtype">int</span> sig) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structuvw_1_1signal__event.html#ae7e804328140e651829fadd2dd9ebf83"> 15</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structuvw_1_1signal__event.html#ae7e804328140e651829fadd2dd9ebf83">signum</a>; </div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>};</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classuvw_1_1signal__handle.html"> 31</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1signal__handle.html">signal_handle</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1handle.html">handle</a><signal_handle, uv_signal_t, signal_event> {</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">static</span> <span class="keywordtype">void</span> start_callback(uv_signal_t *hndl, <span class="keywordtype">int</span> signum);</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using </span>handle::handle;</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classuvw_1_1signal__handle.html#abc6b619bd929278756c05d2a9675f6fb"> 41</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1signal__handle.html#abc6b619bd929278756c05d2a9675f6fb">init</a>() final;</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classuvw_1_1signal__handle.html#a95b15ae0dc1fa65447613b45a1bf613c"> 51</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1signal__handle.html#a95b15ae0dc1fa65447613b45a1bf613c">start</a>(<span class="keywordtype">int</span> signum);</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classuvw_1_1signal__handle.html#a4fad746f07a5ef096864989c8ee298de"> 62</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1signal__handle.html#a4fad746f07a5ef096864989c8ee298de">one_shot</a>(<span class="keywordtype">int</span> signum);</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classuvw_1_1signal__handle.html#aff5b21c725cc342e9e140a0dfed97819"> 68</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1signal__handle.html#aff5b21c725cc342e9e140a0dfed97819">stop</a>();</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classuvw_1_1signal__handle.html#a6abb706a3e1c215bd24af5db4e39098b"> 74</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1signal__handle.html#a6abb706a3e1c215bd24af5db4e39098b">signal</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>};</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>} <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="preprocessor"># include "signal.cpp"</span></div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#endif </span><span class="comment">// UVW_SIGNAL_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_1signal__handle_html"><div class="ttname"><a href="classuvw_1_1signal__handle.html">uvw::signal_handle</a></div><div class="ttdoc">The signal handle.</div><div class="ttdef"><b>Definition:</b> <a href="signal_8h_source.html#l00031">signal.h:31</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1signal__handle_html_a4fad746f07a5ef096864989c8ee298de"><div class="ttname"><a href="classuvw_1_1signal__handle.html#a4fad746f07a5ef096864989c8ee298de">uvw::signal_handle::one_shot</a></div><div class="ttdeci">int one_shot(int signum)</div><div class="ttdoc">Starts the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1signal__handle_html_a6abb706a3e1c215bd24af5db4e39098b"><div class="ttname"><a href="classuvw_1_1signal__handle.html#a6abb706a3e1c215bd24af5db4e39098b">uvw::signal_handle::signal</a></div><div class="ttdeci">int signal() const noexcept</div><div class="ttdoc">Gets the signal being monitored.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1signal__handle_html_a95b15ae0dc1fa65447613b45a1bf613c"><div class="ttname"><a href="classuvw_1_1signal__handle.html#a95b15ae0dc1fa65447613b45a1bf613c">uvw::signal_handle::start</a></div><div class="ttdeci">int start(int signum)</div><div class="ttdoc">Starts the handle.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1signal__handle_html_abc6b619bd929278756c05d2a9675f6fb"><div class="ttname"><a href="classuvw_1_1signal__handle.html#abc6b619bd929278756c05d2a9675f6fb">uvw::signal_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_1signal__handle_html_aff5b21c725cc342e9e140a0dfed97819"><div class="ttname"><a href="classuvw_1_1signal__handle.html#aff5b21c725cc342e9e140a0dfed97819">uvw::signal_handle::stop</a></div><div class="ttdeci">int stop()</div><div class="ttdoc">Stops the handle.</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="astructuvw_1_1signal__event_html"><div class="ttname"><a href="structuvw_1_1signal__event.html">uvw::signal_event</a></div><div class="ttdoc">Signal event.</div><div class="ttdef"><b>Definition:</b> <a href="signal_8h_source.html#l00012">signal.h:12</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1signal__event_html_ae7e804328140e651829fadd2dd9ebf83"><div class="ttname"><a href="structuvw_1_1signal__event.html#ae7e804328140e651829fadd2dd9ebf83">uvw::signal_event::signum</a></div><div class="ttdeci">int signum</div><div class="ttdef"><b>Definition:</b> <a href="signal_8h_source.html#l00015">signal.h:15</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>
|