/usr/share/doc/python-pyinotify-doc/html/pyinotify.ThreadedNotifier-class.html is in python-pyinotify-doc 0.9.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>pyinotify.ThreadedNotifier</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyinotify-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="pyinotify-module.html">Module pyinotify</a> ::
Class ThreadedNotifier
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="pyinotify.ThreadedNotifier-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ThreadedNotifier</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier">source code</a></span></p>
<pre class="base-tree">
object --+
|
threading._Verbose --+
|
threading.Thread --+
|
object --+ |
| |
<a href="pyinotify.Notifier-class.html">Notifier</a> --+
|
<strong class="uidshort">ThreadedNotifier</strong>
</pre>
<hr />
<p>This notifier inherits from threading.Thread for instanciating a
separate thread, and also inherits from Notifier, because it is a
threaded notifier.</p>
<p>Note that every functionality provided by this class is also provided
through Notifier class. Moreover Notifier should be considered first
because it is not threaded and could be easily daemonized.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyinotify.ThreadedNotifier-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">watch_manager</span>,
<span class="summary-sig-arg">default_proc_fun</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">read_freq</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">threshold</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br />
Initialization, initialize base classes.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyinotify.ThreadedNotifier-class.html#stop" class="summary-sig-name">stop</a>(<span class="summary-sig-arg">self</span>)</span><br />
Stop notifier's loop.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.stop">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyinotify.ThreadedNotifier-class.html#loop" class="summary-sig-name">loop</a>(<span class="summary-sig-arg">self</span>)</span><br />
Thread's main loop.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.loop">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyinotify.ThreadedNotifier-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span><br />
Start thread's loop: read and process events until the method stop()
is called.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.run">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
<code>__repr__</code>,
<code>getName</code>,
<code>isAlive</code>,
<code>isDaemon</code>,
<code>is_alive</code>,
<code>join</code>,
<code>setDaemon</code>,
<code>setName</code>,
<code>start</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
<code>_reset_internal_locks</code>,
<code>_set_daemon</code>,
<code>_set_ident</code>
</p></div>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading._Verbose</code></b> (private):
<code>_note</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify.Notifier-class.html">Notifier</a></code></b>:
<code><a href="pyinotify.Notifier-class.html#append_event">append_event</a></code>,
<code><a href="pyinotify.Notifier-class.html#check_events">check_events</a></code>,
<code><a href="pyinotify.Notifier-class.html#coalesce_events">coalesce_events</a></code>,
<code><a href="pyinotify.Notifier-class.html#proc_fun">proc_fun</a></code>,
<code><a href="pyinotify.Notifier-class.html#process_events">process_events</a></code>,
<code><a href="pyinotify.Notifier-class.html#read_events">read_events</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyinotify.Notifier-class.html">Notifier</a></code></b> (private):
<code><a href="pyinotify.Notifier-class.html#_sleep" onclick="show_private();">_sleep</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
<code>daemon</code>,
<code>ident</code>,
<code>name</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
<code>_block</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">watch_manager</span>,
<span class="sig-arg">default_proc_fun</span>=<span class="sig-default">None</span>,
<span class="sig-arg">read_freq</span>=<span class="sig-default">0</span>,
<span class="sig-arg">threshold</span>=<span class="sig-default">0</span>,
<span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.__init__">source code</a></span>
</td>
</tr></table>
<p>Initialization, initialize base classes. read_freq, threshold and
timeout parameters are used when looping.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>watch_manager</code></strong> (WatchManager instance) - Watch Manager.</li>
<li><strong class="pname"><code>default_proc_fun</code></strong> (instance of ProcessEvent) - Default processing method. See base class.</li>
<li><strong class="pname"><code>read_freq</code></strong> (int) - if read_freq == 0, events are read asap, if read_freq is > 0,
this thread sleeps max(0, read_freq - (timeout / 1000)) seconds.</li>
<li><strong class="pname"><code>threshold</code></strong> (int) - File descriptor will be read only if the accumulated size to read
becomes >= threshold. If != 0, you likely want to use it in
combination with an appropriate value set for read_freq because
without that you would keep looping without really reading
anything and that until the amount of events to read is >=
threshold. At least with read_freq you might sleep.</li>
<li><strong class="pname"><code>timeout</code></strong> (int) - see read_freq above. If provided, it must be set in milliseconds.
See
https://docs.python.org/2/library/select.html#select.poll.poll</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="stop"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">stop</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.stop">source code</a></span>
</td>
</tr></table>
<p>Stop notifier's loop. Stop notification. Join the thread.</p>
<dl class="fields">
<dt>Overrides:
<a href="pyinotify.Notifier-class.html#stop">Notifier.stop</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="loop"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">loop</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.loop">source code</a></span>
</td>
</tr></table>
<p>Thread's main loop. Don't meant to be called by user directly. Call
inherited start() method instead.</p>
<p>Events are read only once time every min(read_freq, timeout) seconds
at best and only if the size of events to read is >= threshold.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>callback</code></strong> - Functor called after each event processing iteration. Expects to
receive the notifier object (self) as first parameter. If this
function returns True the loop is immediately terminated
otherwise the loop method keeps looping.</li>
<li><strong class="pname"><code>daemonize</code></strong> - This thread is daemonized if set to True.</li>
<li><strong class="pname"><code>args</code></strong> - Optional and relevant only if daemonize is True. Remaining
keyworded arguments are directly passed to daemonize see
__daemonize() method. If pid_file=None or is set to a pathname
the caller must ensure the file does not exist before this method
is called otherwise an exception pyinotify.NotifierError will be
raised. If pid_file=False it is still daemonized but the pid is
not written in any file.</li>
</ul></dd>
<dt>Overrides:
<a href="pyinotify.Notifier-class.html#loop">Notifier.loop</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="run"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyinotify-pysrc.html#ThreadedNotifier.run">source code</a></span>
</td>
</tr></table>
<p>Start thread's loop: read and process events until the method stop()
is called. Never call this method directly, instead call the start()
method inherited from threading.Thread, which then will call run() in its
turn.</p>
<dl class="fields">
<dt>Overrides:
threading.Thread.run
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyinotify-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
on Fri Jun 3 19:19:13 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|