root / docstrings / pyinotify.SysCtlINotify-class.html

Revision a17385ae4cd3f952f689cfeee0d6e04841a4325e, 21.1 kB (checked in by Sebastien Martini <seb@…>, 6 hours ago)

Updated docstrings generated documentation.

  • Property mode set to 100644
Line 
1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>pyinotify.SysCtlINotify</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
8  <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12      alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15       bgcolor="#a0c0ff" cellspacing="0">
16  <tr valign="middle">
17  <!-- Home link -->
18      <th>&nbsp;&nbsp;&nbsp;<a
19        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21  <!-- Tree link -->
22      <th>&nbsp;&nbsp;&nbsp;<a
23        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25  <!-- Index link -->
26      <th>&nbsp;&nbsp;&nbsp;<a
27        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29  <!-- Help link -->
30      <th>&nbsp;&nbsp;&nbsp;<a
31        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33      <th class="navbar" width="100%"></th>
34  </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37  <tr valign="top">
38    <td width="100%">
39      <span class="breadcrumbs">
40        <a href="pyinotify-module.html">Module&nbsp;pyinotify</a> ::
41        Class&nbsp;SysCtlINotify
42      </span>
43    </td>
44    <td>
45      <table cellpadding="0" cellspacing="0">
46        <!-- hide/show private -->
47        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49        <tr><td align="right"><span class="options"
50            >[<a href="frames.html" target="_top">frames</a
51            >]&nbsp;|&nbsp;<a href="pyinotify.SysCtlINotify-class.html"
52            target="_top">no&nbsp;frames</a>]</span></td></tr>
53      </table>
54    </td>
55  </tr>
56</table>
57<!-- ==================== CLASS DESCRIPTION ==================== -->
58<h1 class="epydoc">Class SysCtlINotify</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify">source&nbsp;code</a></span></p>
59<center>
60<center>  <map id="uml_class_diagram_for_pyinotif_17" name="uml_class_diagram_for_pyinotif_17">
61<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html#inotify_attrs" title="pyinotify.SysCtlINotify.inotify_attrs" alt="" coords="17,28,156,46"/>
62<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html#value" title="pyinotify.SysCtlINotify.value" alt="" coords="17,46,156,65"/>
63<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html#__new__" title="pyinotify.SysCtlINotify.__new__" alt="" coords="17,68,156,86"/>
64<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,86,156,105"/>
65<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html#get_val" title="Returns: &#160;stored value." alt="" coords="17,105,156,124"/>
66<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html#set_val" title="pyinotify.SysCtlINotify.set_val" alt="" coords="17,124,156,142"/>
67<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html#__repr__" title="repr(x)" alt="" coords="17,142,156,161"/>
68<area shape="rect" href="pyinotify.SysCtlINotify&#45;class.html" title="Access (read, write) inotify&#39;s variables through sysctl." alt="" coords="16,10,157,162"/>
69</map>
70  <img src="uml_class_diagram_for_pyinotif_17.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_17" ismap="ismap" class="graph-without-title" />
71</center>
72</center>
73<hr />
74<p>Access (read, write) inotify's variables through sysctl.</p>
75  <p>Examples:</p>
76  <ul>
77    <li>
78      Read variable: myvar = max_queued_events.value
79    </li>
80    <li>
81      Update variable: max_queued_events.value = 42
82    </li>
83  </ul>
84
85<!-- ==================== INSTANCE METHODS ==================== -->
86<a name="section-InstanceMethods"></a>
87<table class="summary" border="1" cellpadding="3"
88       cellspacing="0" width="100%" bgcolor="white">
89<tr bgcolor="#70b0f0" class="table-header">
90  <td colspan="2" class="table-header">
91    <table border="0" cellpadding="0" cellspacing="0" width="100%">
92      <tr valign="top">
93        <td align="left"><span class="table-header">Instance Methods</span></td>
94        <td align="right" valign="top"
95         ><span class="options">[<a href="#section-InstanceMethods"
96         class="privatelink" onclick="toggle_private();"
97         >hide private</a>]</span></td>
98      </tr>
99    </table>
100  </td>
101</tr>
102<tr>
103    <td width="15%" align="right" valign="top" class="summary">
104      <span class="summary-type">&nbsp;</span>
105    </td><td class="summary">
106      <table width="100%" cellpadding="0" cellspacing="0" border="0">
107        <tr>
108          <td><span class="summary-sig"><a href="pyinotify.SysCtlINotify-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
109        <span class="summary-sig-arg">attrname</span>)</span><br />
110      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
111          <td align="right" valign="top">
112            <span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.__init__">source&nbsp;code</a></span>
113           
114          </td>
115        </tr>
116      </table>
117     
118    </td>
119  </tr>
120<tr>
121    <td width="15%" align="right" valign="top" class="summary">
122      <span class="summary-type">int</span>
123    </td><td class="summary">
124      <table width="100%" cellpadding="0" cellspacing="0" border="0">
125        <tr>
126          <td><span class="summary-sig"><a href="pyinotify.SysCtlINotify-class.html#get_val" class="summary-sig-name">get_val</a>(<span class="summary-sig-arg">self</span>)</span><br />
127      Returns:
128      stored value.</td>
129          <td align="right" valign="top">
130            <span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.get_val">source&nbsp;code</a></span>
131           
132          </td>
133        </tr>
134      </table>
135     
136    </td>
137  </tr>
138<tr>
139    <td width="15%" align="right" valign="top" class="summary">
140      <span class="summary-type">&nbsp;</span>
141    </td><td class="summary">
142      <table width="100%" cellpadding="0" cellspacing="0" border="0">
143        <tr>
144          <td><span class="summary-sig"><a href="pyinotify.SysCtlINotify-class.html#set_val" class="summary-sig-name">set_val</a>(<span class="summary-sig-arg">self</span>,
145        <span class="summary-sig-arg">nval</span>)</span></td>
146          <td align="right" valign="top">
147            <span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.set_val">source&nbsp;code</a></span>
148           
149          </td>
150        </tr>
151      </table>
152     
153    </td>
154  </tr>
155<tr>
156    <td width="15%" align="right" valign="top" class="summary">
157      <span class="summary-type">&nbsp;</span>
158    </td><td class="summary">
159      <table width="100%" cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td><span class="summary-sig"><a href="pyinotify.SysCtlINotify-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
162      repr(x)</td>
163          <td align="right" valign="top">
164            <span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.__repr__">source&nbsp;code</a></span>
165           
166          </td>
167        </tr>
168      </table>
169     
170    </td>
171  </tr>
172  <tr>
173    <td colspan="2" class="summary">
174    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
175      <code>__delattr__</code>,
176      <code>__getattribute__</code>,
177      <code>__hash__</code>,
178      <code>__reduce__</code>,
179      <code>__reduce_ex__</code>,
180      <code>__setattr__</code>,
181      <code>__str__</code>
182      </p>
183    </td>
184  </tr>
185</table>
186<!-- ==================== STATIC METHODS ==================== -->
187<a name="section-StaticMethods"></a>
188<table class="summary" border="1" cellpadding="3"
189       cellspacing="0" width="100%" bgcolor="white">
190<tr bgcolor="#70b0f0" class="table-header">
191  <td colspan="2" class="table-header">
192    <table border="0" cellpadding="0" cellspacing="0" width="100%">
193      <tr valign="top">
194        <td align="left"><span class="table-header">Static Methods</span></td>
195        <td align="right" valign="top"
196         ><span class="options">[<a href="#section-StaticMethods"
197         class="privatelink" onclick="toggle_private();"
198         >hide private</a>]</span></td>
199      </tr>
200    </table>
201  </td>
202</tr>
203<tr>
204    <td width="15%" align="right" valign="top" class="summary">
205      <span class="summary-type">a new object with type S, a subtype of T</span>
206    </td><td class="summary">
207      <table width="100%" cellpadding="0" cellspacing="0" border="0">
208        <tr>
209          <td><span class="summary-sig"><a href="pyinotify.SysCtlINotify-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">cls</span>,
210        <span class="summary-sig-arg">*p</span>,
211        <span class="summary-sig-arg">**k</span>)</span></td>
212          <td align="right" valign="top">
213            <span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.__new__">source&nbsp;code</a></span>
214           
215          </td>
216        </tr>
217      </table>
218     
219    </td>
220  </tr>
221</table>
222<!-- ==================== CLASS VARIABLES ==================== -->
223<a name="section-ClassVariables"></a>
224<table class="summary" border="1" cellpadding="3"
225       cellspacing="0" width="100%" bgcolor="white">
226<tr bgcolor="#70b0f0" class="table-header">
227  <td colspan="2" class="table-header">
228    <table border="0" cellpadding="0" cellspacing="0" width="100%">
229      <tr valign="top">
230        <td align="left"><span class="table-header">Class Variables</span></td>
231        <td align="right" valign="top"
232         ><span class="options">[<a href="#section-ClassVariables"
233         class="privatelink" onclick="toggle_private();"
234         >hide private</a>]</span></td>
235      </tr>
236    </table>
237  </td>
238</tr>
239<tr>
240    <td width="15%" align="right" valign="top" class="summary">
241      <span class="summary-type">&nbsp;</span>
242    </td><td class="summary">
243        <a href="pyinotify.SysCtlINotify-class.html#inotify_attrs" class="summary-name">inotify_attrs</a> = <code title="{'max_queued_events': 3,
244 'max_user_instances': 1,
245 'max_user_watches': 2}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">max_queued_events</code><code class="variable-quote">'</code><code class="variable-op">: </code>3<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">max_user_instances</code><code class="variable-quote">'</code><code class="variable-op">:</code><code class="variable-ellipsis">...</code></code>
246    </td>
247  </tr>
248</table>
249<!-- ==================== PROPERTIES ==================== -->
250<a name="section-Properties"></a>
251<table class="summary" border="1" cellpadding="3"
252       cellspacing="0" width="100%" bgcolor="white">
253<tr bgcolor="#70b0f0" class="table-header">
254  <td colspan="2" class="table-header">
255    <table border="0" cellpadding="0" cellspacing="0" width="100%">
256      <tr valign="top">
257        <td align="left"><span class="table-header">Properties</span></td>
258        <td align="right" valign="top"
259         ><span class="options">[<a href="#section-Properties"
260         class="privatelink" onclick="toggle_private();"
261         >hide private</a>]</span></td>
262      </tr>
263    </table>
264  </td>
265</tr>
266<tr>
267    <td width="15%" align="right" valign="top" class="summary">
268      <span class="summary-type">int</span>
269    </td><td class="summary">
270        <a href="pyinotify.SysCtlINotify-class.html#value" class="summary-name">value</a>
271    </td>
272  </tr>
273  <tr>
274    <td colspan="2" class="summary">
275    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
276      <code>__class__</code>
277      </p>
278    </td>
279  </tr>
280</table>
281<!-- ==================== METHOD DETAILS ==================== -->
282<a name="section-MethodDetails"></a>
283<table class="details" border="1" cellpadding="3"
284       cellspacing="0" width="100%" bgcolor="white">
285<tr bgcolor="#70b0f0" class="table-header">
286  <td colspan="2" class="table-header">
287    <table border="0" cellpadding="0" cellspacing="0" width="100%">
288      <tr valign="top">
289        <td align="left"><span class="table-header">Method Details</span></td>
290        <td align="right" valign="top"
291         ><span class="options">[<a href="#section-MethodDetails"
292         class="privatelink" onclick="toggle_private();"
293         >hide private</a>]</span></td>
294      </tr>
295    </table>
296  </td>
297</tr>
298</table>
299<a name="__new__"></a>
300<div>
301<table class="details" border="1" cellpadding="3"
302       cellspacing="0" width="100%" bgcolor="white">
303<tr><td>
304  <table width="100%" cellpadding="0" cellspacing="0" border="0">
305  <tr valign="top"><td>
306  <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">cls</span>,
307        <span class="sig-arg">*p</span>,
308        <span class="sig-arg">**k</span>)</span>
309    <br /><em class="fname">Static Method</em>
310  </h3>
311  </td><td align="right" valign="top"
312    ><span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.__new__">source&nbsp;code</a></span>&nbsp;
313    </td>
314  </tr></table>
315 
316 
317  <dl class="fields">
318    <dt>Returns: a new object with type S, a subtype of T</dt>
319    <dt>Overrides:
320        object.__new__
321        <dd><em class="note">(inherited documentation)</em></dd>
322    </dt>
323  </dl>
324</td></tr></table>
325</div>
326<a name="__init__"></a>
327<div>
328<table class="details" border="1" cellpadding="3"
329       cellspacing="0" width="100%" bgcolor="white">
330<tr><td>
331  <table width="100%" cellpadding="0" cellspacing="0" border="0">
332  <tr valign="top"><td>
333  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
334        <span class="sig-arg">attrname</span>)</span>
335    <br /><em class="fname">(Constructor)</em>
336  </h3>
337  </td><td align="right" valign="top"
338    ><span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.__init__">source&nbsp;code</a></span>&nbsp;
339    </td>
340  </tr></table>
341 
342  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for
343  signature</p>
344  <dl class="fields">
345    <dt>Overrides:
346        object.__init__
347        <dd><em class="note">(inherited documentation)</em></dd>
348    </dt>
349  </dl>
350</td></tr></table>
351</div>
352<a name="get_val"></a>
353<div>
354<table class="details" border="1" cellpadding="3"
355       cellspacing="0" width="100%" bgcolor="white">
356<tr><td>
357  <table width="100%" cellpadding="0" cellspacing="0" border="0">
358  <tr valign="top"><td>
359  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_val</span>(<span class="sig-arg">self</span>)</span>
360  </h3>
361  </td><td align="right" valign="top"
362    ><span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.get_val">source&nbsp;code</a></span>&nbsp;
363    </td>
364  </tr></table>
365 
366 
367  <dl class="fields">
368    <dt>Returns: int</dt>
369        <dd>stored value.</dd>
370  </dl>
371</td></tr></table>
372</div>
373<a name="set_val"></a>
374<div>
375<table class="details" border="1" cellpadding="3"
376       cellspacing="0" width="100%" bgcolor="white">
377<tr><td>
378  <table width="100%" cellpadding="0" cellspacing="0" border="0">
379  <tr valign="top"><td>
380  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_val</span>(<span class="sig-arg">self</span>,
381        <span class="sig-arg">nval</span>)</span>
382  </h3>
383  </td><td align="right" valign="top"
384    ><span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.set_val">source&nbsp;code</a></span>&nbsp;
385    </td>
386  </tr></table>
387 
388 
389  <dl class="fields">
390    <dt>Parameters:</dt>
391    <dd><ul class="nomargin-top">
392        <li><strong class="pname"><code>nval</code></strong> (int) - set to nval.</li>
393    </ul></dd>
394  </dl>
395</td></tr></table>
396</div>
397<a name="__repr__"></a>
398<div>
399<table class="details" border="1" cellpadding="3"
400       cellspacing="0" width="100%" bgcolor="white">
401<tr><td>
402  <table width="100%" cellpadding="0" cellspacing="0" border="0">
403  <tr valign="top"><td>
404  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
405    <br /><em class="fname">(Representation operator)</em>
406  </h3>
407  </td><td align="right" valign="top"
408    ><span class="codelink"><a href="pyinotify-pysrc.html#SysCtlINotify.__repr__">source&nbsp;code</a></span>&nbsp;
409    </td>
410  </tr></table>
411 
412  <p>repr(x)</p>
413  <dl class="fields">