165 lines
16 KiB
HTML
165 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">
|
|
<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/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 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">fs_event.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_FS_EVENT_INCLUDE_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define UVW_FS_EVENT_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 <string></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> <span class="preprocessor">#include "loop.h"</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>  </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span><a class="code" href="namespaceuvw.html">uvw</a> {</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>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>details {</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>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">enum class</span> UVFsEventFlags: std::underlying_type_t<uv_fs_event_flags> {</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  WATCH_ENTRY = UV_FS_EVENT_WATCH_ENTRY,</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  STAT = UV_FS_EVENT_STAT,</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  RECURSIVE = UV_FS_EVENT_RECURSIVE</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> <span class="keyword">enum class</span> UVFsEvent: std::underlying_type_t<uv_fs_event> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  RENAME = UV_RENAME,</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  CHANGE = UV_CHANGE</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> }</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structuvw_1_1FsEventEvent.html"> 40</a></span> <span class="keyword">struct </span><a class="code" href="structuvw_1_1FsEventEvent.html">FsEventEvent</a> {</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="structuvw_1_1FsEventEvent.html">FsEventEvent</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * pathname, <a class="code" href="classuvw_1_1Flags.html">Flags<details::UVFsEvent></a> events);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structuvw_1_1FsEventEvent.html#a01de69aeafe47e4d8660099283bcae0c"> 49</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="structuvw_1_1FsEventEvent.html#a01de69aeafe47e4d8660099283bcae0c">filename</a>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structuvw_1_1FsEventEvent.html#a6202e6116d6b61d1323ab63b8d4cd0cb"> 59</a></span>  <a class="code" href="classuvw_1_1Flags.html">Flags<details::UVFsEvent></a> <a class="code" href="structuvw_1_1FsEventEvent.html#a6202e6116d6b61d1323ab63b8d4cd0cb">flags</a>;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> };</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classuvw_1_1FsEventHandle.html"> 76</a></span> <span class="keyword">class </span><a class="code" href="classuvw_1_1FsEventHandle.html">FsEventHandle</a> final: <span class="keyword">public</span> <a class="code" href="classuvw_1_1Handle.html">Handle</a><FsEventHandle, uv_fs_event_t> {</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> startCallback(uv_fs_event_t *handle, <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 name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">using</span> Watch = details::UVFsEvent;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">using</span> Event = details::UVFsEventFlags;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">using</span> Handle::Handle;</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1FsEventHandle.html#a9c2e4f2468a1ec48f52b05292cee5132">init</a>();</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1FsEventHandle.html#a3cd01c0e0c227d8b7813719e95da6204">start</a>(std::string <a class="code" href="classuvw_1_1FsEventHandle.html#adc8fc25a6daa924b1097f43ccda5db3c">path</a>, <a class="code" href="classuvw_1_1Flags.html">Flags<Event></a> flags = <a class="code" href="classuvw_1_1Flags.html">Flags<Event></a>{});</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</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_1FsEventHandle.html#a3cd01c0e0c227d8b7813719e95da6204">start</a>(std::string <a class="code" href="classuvw_1_1FsEventHandle.html#adc8fc25a6daa924b1097f43ccda5db3c">path</a>, Event flag);</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">void</span> <a class="code" href="classuvw_1_1FsEventHandle.html#a1060687b08f75465db8a33e377ba52ca">stop</a>();</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  std::string <a class="code" href="classuvw_1_1FsEventHandle.html#adc8fc25a6daa924b1097f43ccda5db3c">path</a>() noexcept;</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>  </div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> }</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</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">#ifndef UVW_AS_LIB</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#include "fs_event.cpp"</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor">#endif // UVW_FS_EVENT_INCLUDE_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassuvw_1_1FsEventHandle_html_a9c2e4f2468a1ec48f52b05292cee5132"><div class="ttname"><a href="classuvw_1_1FsEventHandle.html#a9c2e4f2468a1ec48f52b05292cee5132">uvw::FsEventHandle::init</a></div><div class="ttdeci">bool init()</div><div class="ttdoc">Initializes 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#l00010">async.h:10</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1FsEventHandle_html"><div class="ttname"><a href="classuvw_1_1FsEventHandle.html">uvw::FsEventHandle</a></div><div class="ttdoc">The FsEventHandle handle.</div><div class="ttdef"><b>Definition:</b> <a href="fs__event_8h_source.html#l00076">fs_event.h:76</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1FsEventEvent_html"><div class="ttname"><a href="structuvw_1_1FsEventEvent.html">uvw::FsEventEvent</a></div><div class="ttdoc">FsEventEvent event.</div><div class="ttdef"><b>Definition:</b> <a href="fs__event_8h_source.html#l00040">fs_event.h:40</a></div></div>
|
|
<div class="ttc" id="astructuvw_1_1FsEventEvent_html_a6202e6116d6b61d1323ab63b8d4cd0cb"><div class="ttname"><a href="structuvw_1_1FsEventEvent.html#a6202e6116d6b61d1323ab63b8d4cd0cb">uvw::FsEventEvent::flags</a></div><div class="ttdeci">Flags< details::UVFsEvent > flags</div><div class="ttdoc">Detected events all in one.</div><div class="ttdef"><b>Definition:</b> <a href="fs__event_8h_source.html#l00059">fs_event.h:59</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1FsEventHandle_html_adc8fc25a6daa924b1097f43ccda5db3c"><div class="ttname"><a href="classuvw_1_1FsEventHandle.html#adc8fc25a6daa924b1097f43ccda5db3c">uvw::FsEventHandle::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_1Flags_html"><div class="ttname"><a href="classuvw_1_1Flags.html">uvw::Flags< details::UVFsEvent ></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="astructuvw_1_1FsEventEvent_html_a01de69aeafe47e4d8660099283bcae0c"><div class="ttname"><a href="structuvw_1_1FsEventEvent.html#a01de69aeafe47e4d8660099283bcae0c">uvw::FsEventEvent::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#l00049">fs_event.h:49</a></div></div>
|
|
<div class="ttc" id="aclassuvw_1_1FsEventHandle_html_a1060687b08f75465db8a33e377ba52ca"><div class="ttname"><a href="classuvw_1_1FsEventHandle.html#a1060687b08f75465db8a33e377ba52ca">uvw::FsEventHandle::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_1FsEventHandle_html_a3cd01c0e0c227d8b7813719e95da6204"><div class="ttname"><a href="classuvw_1_1FsEventHandle.html#a3cd01c0e0c227d8b7813719e95da6204">uvw::FsEventHandle::start</a></div><div class="ttdeci">void start(std::string path, Flags< Event > flags=Flags< Event >{})</div><div class="ttdoc">Starts watching the specified path.</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>
|