PageRenderTime 48ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/incron-0.5.9/doc/html/inotify-cxx_8h.html

#
HTML | 366 lines | 317 code | 48 blank | 1 comment | 0 complexity | 9eabd3268cf4f8b1f69f2bbb93fc458d MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
  3. <title>incron: inotify-cxx.h File Reference</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. </head><body>
  7. <!-- Generated by Doxygen 1.5.6 -->
  8. <div class="navigation" id="top">
  9. <div class="tabs">
  10. <ul>
  11. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12. <li><a href="annotated.html"><span>Classes</span></a></li>
  13. <li class="current"><a href="files.html"><span>Files</span></a></li>
  14. </ul>
  15. </div>
  16. </div>
  17. <div class="contents">
  18. <h1>inotify-cxx.h File Reference</h1>inotify C++ interface header <a href="#_details">More...</a>
  19. <p>
  20. <code>#include &lt;stdint.h&gt;</code><br>
  21. <code>#include &lt;string&gt;</code><br>
  22. <code>#include &lt;deque&gt;</code><br>
  23. <code>#include &lt;map&gt;</code><br>
  24. <code>#include &lt;sys/syscall.h&gt;</code><br>
  25. <code>#include &lt;sys/inotify.h&gt;</code><br>
  26. <code>#include &lt;sys/inotify-syscalls.h&gt;</code><br>
  27. <p>
  28. <a href="inotify-cxx_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  29. <tr><td></td></tr>
  30. <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  31. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotifyException.html">InotifyException</a></td></tr>
  32. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class for inotify exceptions. <a href="classInotifyException.html#_details">More...</a><br></td></tr>
  33. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotifyEvent.html">InotifyEvent</a></td></tr>
  34. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inotify event class <a href="classInotifyEvent.html#_details">More...</a><br></td></tr>
  35. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotifyWatch.html">InotifyWatch</a></td></tr>
  36. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inotify watch class <a href="classInotifyWatch.html#_details">More...</a><br></td></tr>
  37. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html">Inotify</a></td></tr>
  38. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inotify class <a href="classInotify.html#_details">More...</a><br></td></tr>
  39. <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
  40. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#f64b4cc985ba26f31a9cb242153a5014">INOTIFY_EVENT_SIZE</a>&nbsp;&nbsp;&nbsp;(sizeof(struct inotify_event))</td></tr>
  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event struct size. <a href="#f64b4cc985ba26f31a9cb242153a5014"></a><br></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#a84911f8e42d71161b60d4a28940abb4">INOTIFY_BUFLEN</a>&nbsp;&nbsp;&nbsp;(1024 * (INOTIFY_EVENT_SIZE + 16))</td></tr>
  43. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event buffer length. <a href="#a84911f8e42d71161b60d4a28940abb4"></a><br></td></tr>
  44. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#fe6b93f7e09db7022f1f9dd102932e12">IN_EXC_MSG</a>(msg)&nbsp;&nbsp;&nbsp;(std::string(__PRETTY_FUNCTION__) + &quot;: &quot; + msg)</td></tr>
  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper macro for creating exception messages. <a href="#fe6b93f7e09db7022f1f9dd102932e12"></a><br></td></tr>
  46. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#904d25c0fd931e1bad4f9d5cd346a766">IN_LOCK_DECL</a></td></tr>
  47. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inotify-cxx thread safety <a href="#904d25c0fd931e1bad4f9d5cd346a766"></a><br></td></tr>
  48. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#981aa546075fba39715fd2f63a41f575">IN_LOCK_INIT</a></td></tr>
  49. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#08422ec66fb587c1684afbaa575a53dd">IN_LOCK_DONE</a></td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#963a97dc42487e86715b4e04639b0db8">IN_READ_BEGIN</a></td></tr>
  51. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#0b82080ab6709175341b97e1f3c3955d">IN_READ_END</a></td></tr>
  52. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#5c6a5be1898ef17662795cc4b420c851">IN_READ_END_NOTHROW</a></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#c3a6d87ace9403f7ac58f931bbcd9599">IN_WRITE_BEGIN</a></td></tr>
  54. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#f8aeac51b3b4ef56f1791c5c1a2e9cf5">IN_WRITE_END</a></td></tr>
  55. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#7e68c4884137939c5e3301f40c198dc7">IN_WRITE_END_NOTHROW</a></td></tr>
  56. <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
  57. <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int32_t, <br>
  58. <a class="el" href="classInotifyWatch.html">InotifyWatch</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#e6b5ebcb4e0d6a9f5ca8da26bc00cc2a">IN_WATCH_MAP</a></td></tr>
  59. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mapping from watch descriptors to watch objects. <a href="#e6b5ebcb4e0d6a9f5ca8da26bc00cc2a"></a><br></td></tr>
  60. <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; std::string, <br>
  61. <a class="el" href="classInotifyWatch.html">InotifyWatch</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#5dd7761ff5a6b7cc7271950aebb7ddf6">IN_WP_MAP</a></td></tr>
  62. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mapping from paths to watch objects. <a href="#5dd7761ff5a6b7cc7271950aebb7ddf6"></a><br></td></tr>
  63. <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
  64. <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="inotify-cxx_8h.html#bccd39d32dd83905178cf42edaae5c4d">InotifyCapability_t</a> { <a class="el" href="inotify-cxx_8h.html#bccd39d32dd83905178cf42edaae5c4d18e969c9c44523b38a13b0a207286dd1">IN_MAX_EVENTS</a> = 0,
  65. <a class="el" href="inotify-cxx_8h.html#bccd39d32dd83905178cf42edaae5c4d43cc45296a9afe5cb68f568176608dd9">IN_MAX_INSTANCES</a> = 1,
  66. <a class="el" href="inotify-cxx_8h.html#bccd39d32dd83905178cf42edaae5c4d594390780d2bdcec064c00aec1f20429">IN_MAX_WATCHES</a> = 2
  67. }</td></tr>
  68. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inotify capability/limit identifiers <a href="inotify-cxx_8h.html#bccd39d32dd83905178cf42edaae5c4d">More...</a><br></td></tr>
  69. </table>
  70. <hr><a name="_details"></a><h2>Detailed Description</h2>
  71. inotify C++ interface header
  72. <p>
  73. inotify C++ interface<p>
  74. Copyright (C) 2006, 2007, 2008 Lukas Jelinek, &lt;<a href="mailto:lukas@aiken.cz">lukas@aiken.cz</a>&gt;<p>
  75. This program is free software; you can redistribute it and/or modify it under the terms of one of the following licenses:<p>
  76. <ul>
  77. <li>1. X11-style license (see LICENSE-X11) </li>
  78. <li>2. GNU Lesser General Public License, version 2.1 (see LICENSE-LGPL) </li>
  79. <li>3. GNU General Public License, version 2 (see LICENSE-GPL)</li>
  80. </ul>
  81. If you want to help with choosing the best license for you, please visit <a href="http://www.gnu.org/licenses/license-list.html.">http://www.gnu.org/licenses/license-list.html.</a> <hr><h2>Define Documentation</h2>
  82. <a class="anchor" name="fe6b93f7e09db7022f1f9dd102932e12"></a><!-- doxytag: member="inotify-cxx.h::IN_EXC_MSG" ref="fe6b93f7e09db7022f1f9dd102932e12" args="(msg)" -->
  83. <div class="memitem">
  84. <div class="memproto">
  85. <table class="memname">
  86. <tr>
  87. <td class="memname">#define IN_EXC_MSG </td>
  88. <td>(</td>
  89. <td class="paramtype">msg&nbsp;</td>
  90. <td class="paramname"> </td>
  91. <td>&nbsp;)&nbsp;</td>
  92. <td>&nbsp;&nbsp;&nbsp;(std::string(__PRETTY_FUNCTION__) + &quot;: &quot; + msg)</td>
  93. </tr>
  94. </table>
  95. </div>
  96. <div class="memdoc">
  97. <p>
  98. Helper macro for creating exception messages.
  99. <p>
  100. It prepends the message by the function name.
  101. </div>
  102. </div><p>
  103. <a class="anchor" name="904d25c0fd931e1bad4f9d5cd346a766"></a><!-- doxytag: member="inotify-cxx.h::IN_LOCK_DECL" ref="904d25c0fd931e1bad4f9d5cd346a766" args="" -->
  104. <div class="memitem">
  105. <div class="memproto">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">#define IN_LOCK_DECL </td>
  109. </tr>
  110. </table>
  111. </div>
  112. <div class="memdoc">
  113. <p>
  114. inotify-cxx thread safety
  115. <p>
  116. If this symbol is defined you can use this interface safely threaded applications. Remember that it slightly degrades performance.<p>
  117. Even if INOTIFY_THREAD_SAFE is defined some classes stay unsafe. If you must use them (must you?) in more than one thread concurrently you need to implement explicite locking.<p>
  118. You need not to define INOTIFY_THREAD_SAFE in that cases where the application is multithreaded but all the inotify infrastructure will be managed only in one thread. This is the recommended way.<p>
  119. Locking may fail (it is very rare but not impossible). In this case an exception is thrown. But if unlocking fails in case of an error it does nothing (this failure is ignored).
  120. </div>
  121. </div><p>
  122. <a class="anchor" name="08422ec66fb587c1684afbaa575a53dd"></a><!-- doxytag: member="inotify-cxx.h::IN_LOCK_DONE" ref="08422ec66fb587c1684afbaa575a53dd" args="" -->
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">#define IN_LOCK_DONE </td>
  128. </tr>
  129. </table>
  130. </div>
  131. <div class="memdoc">
  132. <p>
  133. </div>
  134. </div><p>
  135. <a class="anchor" name="981aa546075fba39715fd2f63a41f575"></a><!-- doxytag: member="inotify-cxx.h::IN_LOCK_INIT" ref="981aa546075fba39715fd2f63a41f575" args="" -->
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">#define IN_LOCK_INIT </td>
  141. </tr>
  142. </table>
  143. </div>
  144. <div class="memdoc">
  145. <p>
  146. </div>
  147. </div><p>
  148. <a class="anchor" name="963a97dc42487e86715b4e04639b0db8"></a><!-- doxytag: member="inotify-cxx.h::IN_READ_BEGIN" ref="963a97dc42487e86715b4e04639b0db8" args="" -->
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">#define IN_READ_BEGIN </td>
  154. </tr>
  155. </table>
  156. </div>
  157. <div class="memdoc">
  158. <p>
  159. </div>
  160. </div><p>
  161. <a class="anchor" name="0b82080ab6709175341b97e1f3c3955d"></a><!-- doxytag: member="inotify-cxx.h::IN_READ_END" ref="0b82080ab6709175341b97e1f3c3955d" args="" -->
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">#define IN_READ_END </td>
  167. </tr>
  168. </table>
  169. </div>
  170. <div class="memdoc">
  171. <p>
  172. </div>
  173. </div><p>
  174. <a class="anchor" name="5c6a5be1898ef17662795cc4b420c851"></a><!-- doxytag: member="inotify-cxx.h::IN_READ_END_NOTHROW" ref="5c6a5be1898ef17662795cc4b420c851" args="" -->
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">#define IN_READ_END_NOTHROW </td>
  180. </tr>
  181. </table>
  182. </div>
  183. <div class="memdoc">
  184. <p>
  185. </div>
  186. </div><p>
  187. <a class="anchor" name="c3a6d87ace9403f7ac58f931bbcd9599"></a><!-- doxytag: member="inotify-cxx.h::IN_WRITE_BEGIN" ref="c3a6d87ace9403f7ac58f931bbcd9599" args="" -->
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">#define IN_WRITE_BEGIN </td>
  193. </tr>
  194. </table>
  195. </div>
  196. <div class="memdoc">
  197. <p>
  198. </div>
  199. </div><p>
  200. <a class="anchor" name="f8aeac51b3b4ef56f1791c5c1a2e9cf5"></a><!-- doxytag: member="inotify-cxx.h::IN_WRITE_END" ref="f8aeac51b3b4ef56f1791c5c1a2e9cf5" args="" -->
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">#define IN_WRITE_END </td>
  206. </tr>
  207. </table>
  208. </div>
  209. <div class="memdoc">
  210. <p>
  211. </div>
  212. </div><p>
  213. <a class="anchor" name="7e68c4884137939c5e3301f40c198dc7"></a><!-- doxytag: member="inotify-cxx.h::IN_WRITE_END_NOTHROW" ref="7e68c4884137939c5e3301f40c198dc7" args="" -->
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">#define IN_WRITE_END_NOTHROW </td>
  219. </tr>
  220. </table>
  221. </div>
  222. <div class="memdoc">
  223. <p>
  224. </div>
  225. </div><p>
  226. <a class="anchor" name="a84911f8e42d71161b60d4a28940abb4"></a><!-- doxytag: member="inotify-cxx.h::INOTIFY_BUFLEN" ref="a84911f8e42d71161b60d4a28940abb4" args="" -->
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">#define INOTIFY_BUFLEN&nbsp;&nbsp;&nbsp;(1024 * (INOTIFY_EVENT_SIZE + 16)) </td>
  232. </tr>
  233. </table>
  234. </div>
  235. <div class="memdoc">
  236. <p>
  237. Event buffer length.
  238. <p>
  239. </div>
  240. </div><p>
  241. <a class="anchor" name="f64b4cc985ba26f31a9cb242153a5014"></a><!-- doxytag: member="inotify-cxx.h::INOTIFY_EVENT_SIZE" ref="f64b4cc985ba26f31a9cb242153a5014" args="" -->
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">#define INOTIFY_EVENT_SIZE&nbsp;&nbsp;&nbsp;(sizeof(struct inotify_event)) </td>
  247. </tr>
  248. </table>
  249. </div>
  250. <div class="memdoc">
  251. <p>
  252. Event struct size.
  253. <p>
  254. </div>
  255. </div><p>
  256. <hr><h2>Typedef Documentation</h2>
  257. <a class="anchor" name="e6b5ebcb4e0d6a9f5ca8da26bc00cc2a"></a><!-- doxytag: member="inotify-cxx.h::IN_WATCH_MAP" ref="e6b5ebcb4e0d6a9f5ca8da26bc00cc2a" args="" -->
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">typedef std::map&lt;int32_t, <a class="el" href="classInotifyWatch.html">InotifyWatch</a>*&gt; <a class="el" href="inotify-cxx_8h.html#e6b5ebcb4e0d6a9f5ca8da26bc00cc2a">IN_WATCH_MAP</a> </td>
  263. </tr>
  264. </table>
  265. </div>
  266. <div class="memdoc">
  267. <p>
  268. Mapping from watch descriptors to watch objects.
  269. <p>
  270. </div>
  271. </div><p>
  272. <a class="anchor" name="5dd7761ff5a6b7cc7271950aebb7ddf6"></a><!-- doxytag: member="inotify-cxx.h::IN_WP_MAP" ref="5dd7761ff5a6b7cc7271950aebb7ddf6" args="" -->
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname">typedef std::map&lt;std::string, <a class="el" href="classInotifyWatch.html">InotifyWatch</a>*&gt; <a class="el" href="inotify-cxx_8h.html#5dd7761ff5a6b7cc7271950aebb7ddf6">IN_WP_MAP</a> </td>
  278. </tr>
  279. </table>
  280. </div>
  281. <div class="memdoc">
  282. <p>
  283. Mapping from paths to watch objects.
  284. <p>
  285. </div>
  286. </div><p>
  287. <hr><h2>Enumeration Type Documentation</h2>
  288. <a class="anchor" name="bccd39d32dd83905178cf42edaae5c4d"></a><!-- doxytag: member="inotify-cxx.h::InotifyCapability_t" ref="bccd39d32dd83905178cf42edaae5c4d" args="" -->
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">enum <a class="el" href="inotify-cxx_8h.html#bccd39d32dd83905178cf42edaae5c4d">InotifyCapability_t</a> </td>
  294. </tr>
  295. </table>
  296. </div>
  297. <div class="memdoc">
  298. <p>
  299. inotify capability/limit identifiers
  300. <p>
  301. <dl compact><dt><b>Enumerator: </b></dt><dd>
  302. <table border="0" cellspacing="2" cellpadding="0">
  303. <tr><td valign="top"><em><a class="anchor" name="bccd39d32dd83905178cf42edaae5c4d18e969c9c44523b38a13b0a207286dd1"></a><!-- doxytag: member="IN_MAX_EVENTS" ref="bccd39d32dd83905178cf42edaae5c4d18e969c9c44523b38a13b0a207286dd1" args="" -->IN_MAX_EVENTS</em>&nbsp;</td><td>
  304. max. events in the kernel queue </td></tr>
  305. <tr><td valign="top"><em><a class="anchor" name="bccd39d32dd83905178cf42edaae5c4d43cc45296a9afe5cb68f568176608dd9"></a><!-- doxytag: member="IN_MAX_INSTANCES" ref="bccd39d32dd83905178cf42edaae5c4d43cc45296a9afe5cb68f568176608dd9" args="" -->IN_MAX_INSTANCES</em>&nbsp;</td><td>
  306. max. inotify file descriptors per process </td></tr>
  307. <tr><td valign="top"><em><a class="anchor" name="bccd39d32dd83905178cf42edaae5c4d594390780d2bdcec064c00aec1f20429"></a><!-- doxytag: member="IN_MAX_WATCHES" ref="bccd39d32dd83905178cf42edaae5c4d594390780d2bdcec064c00aec1f20429" args="" -->IN_MAX_WATCHES</em>&nbsp;</td><td>
  308. max. watches per file descriptor </td></tr>
  309. </table>
  310. </dl>
  311. </div>
  312. </div><p>
  313. </div>
  314. <hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 21 22:27:24 2009 for incron by&nbsp;
  315. <a href="http://www.doxygen.org/index.html">
  316. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  317. </body>
  318. </html>