159 lines
17 KiB
HTML
159 lines
17 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/fs_event.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">fs_event.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_FS_EVENT_INCLUDE_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_FS_EVENT_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 <string></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 "loop.h"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "util.h"</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</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"> 15</span><span class="keyword">namespace </span>details {</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><span class="keyword">enum class</span> uvw_fs_event_flags : std::underlying_type_t<uv_fs_event_flags> {</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> WATCH_ENTRY = UV_FS_EVENT_WATCH_ENTRY,</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> STAT = UV_FS_EVENT_STAT,</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> RECURSIVE = UV_FS_EVENT_RECURSIVE,</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><span class="keyword">enum class</span> uvw_fs_event : std::underlying_type_t<uv_fs_event> {</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> RENAME = UV_RENAME,</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> CHANGE = UV_CHANGE</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>};</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>} <span class="comment">// namespace details</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structuvw_1_1fs__event__event.html"> 32</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structuvw_1_1fs__event__event.html">fs_event_event</a> {</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_struct" href="structuvw_1_1fs__event__event.html">fs_event_event</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *pathname, details::uvw_fs_event events);</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structuvw_1_1fs__event__event.html#ac461c2b25f9b9e54f623c169614599b0"> 41</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structuvw_1_1fs__event__event.html#ac461c2b25f9b9e54f623c169614599b0">filename</a>;</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="structuvw_1_1fs__event__event.html#ab819b64d8343c6296ae0a50d8775f623"> 51</a></span> details::uvw_fs_event <a class="code hl_variable" href="structuvw_1_1fs__event__event.html#ab819b64d8343c6296ae0a50d8775f623">flags</a>;</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>};</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classuvw_1_1fs__event__handle.html"> 67</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1fs__event__handle.html">fs_event_handle</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1handle.html">handle</a><fs_event_handle, uv_fs_event_t, fs_event_event> {</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">static</span> <span class="keywordtype">void</span> start_callback(uv_fs_event_t *hndl, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keywordtype">int</span> events, <span class="keywordtype">int</span> status);</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">using </span>watch = details::uvw_fs_event;</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">using </span>event_flags = details::uvw_fs_event_flags;</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">using </span>handle::handle;</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="classuvw_1_1fs__event__handle.html#aae895f7574088279bb67d1b73cbef1cf"> 80</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1fs__event__handle.html#aae895f7574088279bb67d1b73cbef1cf">init</a>() final;</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classuvw_1_1fs__event__handle.html#a47e58ce14337e458e6fb3a3def211adc"> 99</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1fs__event__handle.html#a47e58ce14337e458e6fb3a3def211adc">start</a>(const std::<span class="keywordtype">string</span> &<a class="code hl_function" href="classuvw_1_1fs__event__handle.html#a13fb881aa00798a873659b5093eab1ee">path</a>, event_flags flags = event_flags::_UVW_ENUM);</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="classuvw_1_1fs__event__handle.html#ac3525741bd06e974ddd5d7fd7396d07f"> 105</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1fs__event__handle.html#ac3525741bd06e974ddd5d7fd7396d07f">stop</a>();</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classuvw_1_1fs__event__handle.html#a13fb881aa00798a873659b5093eab1ee"> 111</a></span> std::<span class="keywordtype">string</span> <a class="code hl_function" href="classuvw_1_1fs__event__handle.html#a13fb881aa00798a873659b5093eab1ee">path</a>() noexcept;</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> </div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span>} <span class="comment">// namespace uvw</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="preprocessor">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="preprocessor"># include "fs_event.cpp"</span></div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="preprocessor">#endif </span><span class="comment">// UVW_FS_EVENT_INCLUDE_H</span></div>
|
|
<div class="ttc" id="aclassuvw_1_1fs__event__handle_html"><div class="ttname"><a href="classuvw_1_1fs__event__handle.html">uvw::fs_event_handle</a></div><div class="ttdoc">The fs event handle.</div><div class="ttdef"><b>Definition:</b> <a href="fs__event_8h_source.html#l00067">fs_event.h:67</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1fs__event__handle_html_a13fb881aa00798a873659b5093eab1ee"><div class="ttname"><a href="classuvw_1_1fs__event__handle.html#a13fb881aa00798a873659b5093eab1ee">uvw::fs_event_handle::path</a></div><div class="ttdeci">std::string path() noexcept</div><div class="ttdoc">Gets the path being monitored.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1fs__event__handle_html_a47e58ce14337e458e6fb3a3def211adc"><div class="ttname"><a href="classuvw_1_1fs__event__handle.html#a47e58ce14337e458e6fb3a3def211adc">uvw::fs_event_handle::start</a></div><div class="ttdeci">int start(const std::string &path, event_flags flags=event_flags::_UVW_ENUM)</div><div class="ttdoc">Starts watching the specified path.</div></div>
|
|
<div class="ttc" id="aclassuvw_1_1fs__event__handle_html_aae895f7574088279bb67d1b73cbef1cf"><div class="ttname"><a href="classuvw_1_1fs__event__handle.html#aae895f7574088279bb67d1b73cbef1cf">uvw::fs_event_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_1fs__event__handle_html_ac3525741bd06e974ddd5d7fd7396d07f"><div class="ttname"><a href="classuvw_1_1fs__event__handle.html#ac3525741bd06e974ddd5d7fd7396d07f">uvw::fs_event_handle::stop</a></div><div class="ttdeci">int stop()</div><div class="ttdoc">Stops polling the file descriptor.</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#l00023">handle.hpp:23</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#l00008">async.h:8</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1fs__event__event_html"><div class="ttname"><a href="structuvw_1_1fs__event__event.html">uvw::fs_event_event</a></div><div class="ttdoc">Fs event event.</div><div class="ttdef"><b>Definition:</b> <a href="fs__event_8h_source.html#l00032">fs_event.h:32</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1fs__event__event_html_ab819b64d8343c6296ae0a50d8775f623"><div class="ttname"><a href="structuvw_1_1fs__event__event.html#ab819b64d8343c6296ae0a50d8775f623">uvw::fs_event_event::flags</a></div><div class="ttdeci">details::uvw_fs_event flags</div><div class="ttdoc">Detected events all in one.</div><div class="ttdef"><b>Definition:</b> <a href="fs__event_8h_source.html#l00051">fs_event.h:51</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1fs__event__event_html_ac461c2b25f9b9e54f623c169614599b0"><div class="ttname"><a href="structuvw_1_1fs__event__event.html#ac461c2b25f9b9e54f623c169614599b0">uvw::fs_event_event::filename</a></div><div class="ttdeci">const char * filename</div><div class="ttdoc">The path to the file being monitored.</div><div class="ttdef"><b>Definition:</b> <a href="fs__event_8h_source.html#l00041">fs_event.h:41</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>
|