diff options
Diffstat (limited to 'pyinotify.ProcINotify-class.html')
| -rw-r--r-- | pyinotify.ProcINotify-class.html | 429 |
1 files changed, 429 insertions, 0 deletions
diff --git a/pyinotify.ProcINotify-class.html b/pyinotify.ProcINotify-class.html new file mode 100644 index 0000000..94e6c87 --- /dev/null +++ b/pyinotify.ProcINotify-class.html @@ -0,0 +1,429 @@ +<?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.ProcINotify</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 ProcINotify + </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.ProcINotify-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class ProcINotify</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify">source code</a></span></p> +<center> +<center> <map id="uml_class_diagram_for_pyinotif_14" name="uml_class_diagram_for_pyinotif_14"> +<area shape="rect" id="node1_5" href="pyinotify.ProcINotify-class.html#value" title="Gets attribute's value." alt="" coords="17,29,127,49"/> +<area shape="rect" id="node1_6" href="pyinotify.ProcINotify-class.html#__init__" title="x.__init__(...) initializes x; see help(type(x)) for signature" alt="" coords="17,52,127,72"/> +<area shape="rect" id="node1_7" href="pyinotify.ProcINotify-class.html#get_val" title="Gets attribute's value." alt="" coords="17,72,127,92"/> +<area shape="rect" id="node1_8" href="pyinotify.ProcINotify-class.html#set_val" title="Sets new attribute's value." alt="" coords="17,92,127,112"/> +<area shape="rect" id="node1_9" href="pyinotify.ProcINotify-class.html#__repr__" title="repr(x)" alt="" coords="17,112,127,132"/> +<area shape="rect" id="node1" href="pyinotify.ProcINotify-class.html" title="Access (read, write) inotify's variables through /proc/sys/." alt="" coords="5,5,139,139"/> +</map> + <img src="uml_class_diagram_for_pyinotif_14.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_14" ismap="ismap" class="graph-without-title" /> +</center> +</center> +<hr /> +<p>Access (read, write) inotify's variables through /proc/sys/. Note that + usually it requires administrator rights to update them.</p> + <p>Examples:</p> + <ul> + <li> + Read max_queued_events attribute: myvar = max_queued_events.value + </li> + <li> + Update max_queued_events attribute: max_queued_events.value = 42 + </li> + </ul> + +<!-- ==================== 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.ProcINotify-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">attr</span>)</span><br /> + x.__init__(...) initializes x; see help(type(x)) for signature</td> + <td align="right" valign="top"> + <span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.__init__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">int</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="pyinotify.ProcINotify-class.html#get_val" class="summary-sig-name">get_val</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Gets attribute's value.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.get_val">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.ProcINotify-class.html#set_val" class="summary-sig-name">set_val</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">nval</span>)</span><br /> + Sets new attribute's value.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.set_val">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.ProcINotify-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + repr(x)</td> + <td align="right" valign="top"> + <span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.__repr__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <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 width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">int</span> + </td><td class="summary"> + <a href="pyinotify.ProcINotify-class.html#value" class="summary-name">value</a><br /> + Gets attribute's value. + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <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">attr</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.__init__">source code</a></span> + </td> + </tr></table> + + <p>x.__init__(...) initializes x; see help(type(x)) for signature</p> + <dl class="fields"> + <dt>Overrides: + object.__init__ + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="get_val"></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">get_val</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.get_val">source code</a></span> + </td> + </tr></table> + + <p>Gets attribute's value.</p> + <dl class="fields"> + <dt>Returns: int</dt> + <dd>stored value.</dd> + <dt>Raises:</dt> + <dd><ul class="nomargin-top"> + <li><code><strong class='fraise'>IOError</strong></code> - if corresponding file in /proc/sys cannot be read.</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="set_val"></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">set_val</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">nval</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.set_val">source code</a></span> + </td> + </tr></table> + + <p>Sets new attribute's value.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>nval</code></strong> (int) - replaces current value by nval.</li> + </ul></dd> + <dt>Raises:</dt> + <dd><ul class="nomargin-top"> + <li><code><strong class='fraise'>IOError</strong></code> - if corresponding file in /proc/sys cannot be written.</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="__repr__"></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">__repr__</span>(<span class="sig-arg">self</span>)</span> + <br /><em class="fname">(Representation operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="pyinotify-pysrc.html#ProcINotify.__repr__">source code</a></span> + </td> + </tr></table> + + <p>repr(x)</p> + <dl class="fields"> + <dt>Overrides: + object.__repr__ + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== PROPERTY DETAILS ==================== --> +<a name="section-PropertyDetails"></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">Property Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-PropertyDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="value"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <h3 class="epydoc">value</h3> + <p>Gets attribute's value.</p> + <dl class="fields"> + <dt>Get Method:</dt> + <dd class="value"><span class="summary-sig"><a href="pyinotify.ProcINotify-class.html#get_val" class="summary-sig-name">get_val</a>(<span class="summary-sig-arg">self</span>)</span> + - Gets attribute's value. + </dd> + <dt>Set Method:</dt> + <dd class="value"><span class="summary-sig"><a href="pyinotify.ProcINotify-class.html#set_val" class="summary-sig-name">set_val</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">nval</span>)</span> + - Sets new attribute's value. + </dd> + <dt>Type:</dt> + <dd>int</dd> + </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 Thu Jun 4 11:54:20 2015 + </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> |