root / docstrings / pyinotify.EventsCodes-class.html

Revision a17385ae4cd3f952f689cfeee0d6e04841a4325e, 35.8 kB (checked in by Sebastien Martini <seb@…>, 6 minutes 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.EventsCodes</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;EventsCodes
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.EventsCodes-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 EventsCodes</h1><p class="nomargin-top"><span class="codelink"><a href="pyinotify-pysrc.html#EventsCodes">source&nbsp;code</a></span></p>
59<center>
60<center>  <map id="uml_class_diagram_for_pyinotif_8" name="uml_class_diagram_for_pyinotif_8">
61<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#FLAG_COLLECTIONS" title="pyinotify.EventsCodes.FLAG_COLLECTIONS" alt="" coords="17,28,175,46"/>
62<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#ALL_FLAGS" title="pyinotify.EventsCodes.ALL_FLAGS" alt="" coords="17,46,175,65"/>
63<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#ALL_VALUES" title="pyinotify.EventsCodes.ALL_VALUES" alt="" coords="17,65,175,84"/>
64<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#ALL_EVENTS" title="Alias for considering all of the events." alt="" coords="17,84,175,102"/>
65<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#EVENT_FLAGS" title="pyinotify.EventsCodes.EVENT_FLAGS" alt="" coords="17,102,175,121"/>
66<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_ACCESS" title="File was accessed." alt="" coords="17,121,175,140"/>
67<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_ATTRIB" title="Metadata changed." alt="" coords="17,140,175,158"/>
68<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_CLOSE_NOWRITE" title="Unwrittable file closed." alt="" coords="17,158,175,177"/>
69<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_CLOSE_WRITE" title="Writtable file was closed." alt="" coords="17,177,175,196"/>
70<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_CREATE" title="Subfile was created." alt="" coords="17,196,175,214"/>
71<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_DELETE" title="Subfile was deleted." alt="" coords="17,214,175,233"/>
72<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_DELETE_SELF" title="Self (watched item itself) was deleted." alt="" coords="17,233,175,252"/>
73<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#IN_DONT_FOLLOW" title="don&#39;t follow a symlink (new in kernel 2.6.15)." alt="" coords="17,252,175,270"/>
74<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#SPECIAL_FLAGS" title="pyinotify.EventsCodes.SPECIAL_FLAGS" alt="" coords="17,289,175,308"/>
75<area shape="rect" href="pyinotify.EventsCodes&#45;class.html#maskname" title="Return the event name associated to mask." alt="" coords="17,310,175,329"/>
76<area shape="rect" href="pyinotify.EventsCodes&#45;class.html" title="Set of codes corresponding to each kind of events." alt="" coords="16,10,176,330"/>
77</map>
78  <img src="uml_class_diagram_for_pyinotif_8.gif" alt='' usemap="#uml_class_diagram_for_pyinotif_8" ismap="ismap" class="graph-without-title" />
79</center>
80</center>
81<hr />
82<p>Set of codes corresponding to each kind of events. Some of these flags
83  are used to communicate with inotify, whereas the others are sent to
84  userspace by inotify notifying some events.</p>
85
86<!-- ==================== INSTANCE METHODS ==================== -->
87<a name="section-InstanceMethods"></a>
88<table class="summary" border="1" cellpadding="3"
89       cellspacing="0" width="100%" bgcolor="white">
90<tr bgcolor="#70b0f0" class="table-header">
91  <td colspan="2" class="table-header">
92    <table border="0" cellpadding="0" cellspacing="0" width="100%">
93      <tr valign="top">
94        <td align="left"><span class="table-header">Instance Methods</span></td>
95        <td align="right" valign="top"
96         ><span class="options">[<a href="#section-InstanceMethods"
97         class="privatelink" onclick="toggle_private();"
98         >hide private</a>]</span></td>
99      </tr>
100    </table>
101  </td>
102</tr>
103  <tr>
104    <td colspan="2" class="summary">
105    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
106      <code>__delattr__</code>,
107      <code>__getattribute__</code>,
108      <code>__hash__</code>,
109      <code>__init__</code>,
110      <code>__new__</code>,
111      <code>__reduce__</code>,
112      <code>__reduce_ex__</code>,
113      <code>__repr__</code>,
114      <code>__setattr__</code>,
115      <code>__str__</code>
116      </p>
117    </td>
118  </tr>
119</table>
120<!-- ==================== STATIC METHODS ==================== -->
121<a name="section-StaticMethods"></a>
122<table class="summary" border="1" cellpadding="3"
123       cellspacing="0" width="100%" bgcolor="white">
124<tr bgcolor="#70b0f0" class="table-header">
125  <td colspan="2" class="table-header">
126    <table border="0" cellpadding="0" cellspacing="0" width="100%">
127      <tr valign="top">
128        <td align="left"><span class="table-header">Static Methods</span></td>
129        <td align="right" valign="top"
130         ><span class="options">[<a href="#section-StaticMethods"
131         class="privatelink" onclick="toggle_private();"
132         >hide private</a>]</span></td>
133      </tr>
134    </table>
135  </td>
136</tr>
137<tr>
138    <td width="15%" align="right" valign="top" class="summary">
139      <span class="summary-type">str</span>
140    </td><td class="summary">
141      <table width="100%" cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td><span class="summary-sig"><a href="pyinotify.EventsCodes-class.html#maskname" class="summary-sig-name">maskname</a>(<span class="summary-sig-arg">mask</span>)</span><br />
144      Return the event name associated to mask.</td>
145          <td align="right" valign="top">
146            <span class="codelink"><a href="pyinotify-pysrc.html#EventsCodes.maskname">source&nbsp;code</a></span>
147           
148          </td>
149        </tr>
150      </table>
151     
152    </td>
153  </tr>
154</table>
155<!-- ==================== CLASS VARIABLES ==================== -->
156<a name="section-ClassVariables"></a>
157<table class="summary" border="1" cellpadding="3"
158       cellspacing="0" width="100%" bgcolor="white">
159<tr bgcolor="#70b0f0" class="table-header">
160  <td colspan="2" class="table-header">
161    <table border="0" cellpadding="0" cellspacing="0" width="100%">
162      <tr valign="top">
163        <td align="left"><span class="table-header">Class Variables</span></td>
164        <td align="right" valign="top"
165         ><span class="options">[<a href="#section-ClassVariables"
166         class="privatelink" onclick="toggle_private();"
167         >hide private</a>]</span></td>
168      </tr>
169    </table>
170  </td>
171</tr>
172<tr>
173    <td width="15%" align="right" valign="top" class="summary">
174      <span class="summary-type">&nbsp;</span>
175    </td><td class="summary">
176        <a href="pyinotify.EventsCodes-class.html#FLAG_COLLECTIONS" class="summary-name">FLAG_COLLECTIONS</a> = <code title="{'EVENT_FLAGS': {'IN_IGNORED': 32768,
177                 'IN_Q_OVERFLOW': 16384,
178                 'IN_UNMOUNT': 8192},
179 'OP_FLAGS': {'IN_ACCESS': 1,
180              'IN_ATTRIB': 4,
181              'IN_CLOSE_NOWRITE': 16,
182              'IN_CLOSE_WRITE': 8,
183              'IN_CREATE': 256,
184..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">EVENT_FLAGS</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">IN_IGNORED</code><code class="variable-quote">'</code><code class="variable-op">: </code>32768<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">IN_Q</code><code class="variable-ellipsis">...</code></code>
185    </td>
186  </tr>
187<tr>
188    <td width="15%" align="right" valign="top" class="summary">
189      <span class="summary-type">&nbsp;</span>
190    </td><td class="summary">
191        <a href="pyinotify.EventsCodes-class.html#ALL_FLAGS" class="summary-name">ALL_FLAGS</a> = <code title="{'ALL_EVENTS': 4095,
192 'IN_ACCESS': 1,
193 'IN_ATTRIB': 4,
194 'IN_CLOSE_NOWRITE': 16,
195 'IN_CLOSE_WRITE': 8,
196 'IN_CREATE': 256,
197 'IN_DELETE': 512,
198 'IN_DELETE_SELF': 1024,
199..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">ALL_EVENTS</code><code class="variable-quote">'</code><code class="variable-op">: </code>4095<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">IN_ACCESS</code><code class="variable-quote">'</code><code class="variable-op">: </code>1<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">IN_ATTRIB</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-ellipsis">...</code></code>
200    </td>
201  </tr>
202<tr>
203    <td width="15%" align="right" valign="top" class="summary">
204      <span class="summary-type">&nbsp;</span>
205    </td><td class="summary">
206        <a href="pyinotify.EventsCodes-class.html#ALL_VALUES" class="summary-name">ALL_VALUES</a> = <code title="{1: 'IN_ACCESS',
207 2: 'IN_MODIFY',
208 4: 'IN_ATTRIB',
209 8: 'IN_CLOSE_WRITE',
210 16: 'IN_CLOSE_NOWRITE',
211 32: 'IN_OPEN',
212 64: 'IN_MOVED_FROM',
213 128: 'IN_MOVED_TO',
214..."><code class="variable-group">{</code>1<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">IN_ACCESS</code><code class="variable-quote">'</code><code class="variable-op">, </code>2<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">IN_MODIFY</code><code class="variable-quote">'</code><code class="variable-op">, </code>4<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">IN_ATTRIB</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></code>
215    </td>
216  </tr>
217<tr>
218    <td width="15%" align="right" valign="top" class="summary">
219      <span class="summary-type">int</span>
220    </td><td class="summary">
221        <a name="ALL_EVENTS"></a><span class="summary-name">ALL_EVENTS</span><br />
222      Alias for considering all of the events.
223    </td>
224  </tr>
225<tr>
226    <td width="15%" align="right" valign="top" class="summary">
227      <span class="summary-type">&nbsp;</span>
228    </td><td class="summary">
229        <a href="pyinotify.EventsCodes-class.html#EVENT_FLAGS" class="summary-name">EVENT_FLAGS</a> = <code title="{'IN_IGNORED': 32768, 'IN_Q_OVERFLOW': 16384, 'IN_UNMOUNT': 8192}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">IN_IGNORED</code><code class="variable-quote">'</code><code class="variable-op">: </code>32768<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">IN_Q_OVERFLOW</code><code class="variable-quote">'</code><code class="variable-op">: </code>16384<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">I</code><code class="variable-ellipsis">...</code></code>
230    </td>
231  </tr>
232<tr>
233    <td width="15%" align="right" valign="top" class="summary">
234      <span class="summary-type">int</span>
235    </td><td class="summary">
236        <a name="IN_ACCESS"></a><span class="summary-name">IN_ACCESS</span><br />
237      File was accessed.
238    </td>
239  </tr>
240<tr>
241    <td width="15%" align="right" valign="top" class="summary">
242      <span class="summary-type">int</span>
243    </td><td class="summary">
244        <a name="IN_ATTRIB"></a><span class="summary-name">IN_ATTRIB</span><br />
245      Metadata changed.
246    </td>
247  </tr>
248<tr>
249    <td width="15%" align="right" valign="top" class="summary">
250      <span class="summary-type">int</span>
251    </td><td class="summary">
252        <a name="IN_CLOSE_NOWRITE"></a><span class="summary-name">IN_CLOSE_NOWRITE</span><br />
253      Unwrittable file closed.
254    </td>
255  </tr>
256<tr>
257    <td width="15%" align="right" valign="top" class="summary">
258      <span class="summary-type">int</span>
259    </td><td class="summary">
260        <a name="IN_CLOSE_WRITE"></a><span class="summary-name">IN_CLOSE_WRITE</span><br />
261      Writtable file was closed.
262    </td>
263  </tr>
264<tr>
265    <td width="15%" align="right" valign="top" class="summary">
266      <span class="summary-type">int</span>
267    </td><td class="summary">
268        <a name="IN_CREATE"></a><span class="summary-name">IN_CREATE</span><br />
269      Subfile was created.
270    </td>
271  </tr>
272<tr>
273    <td width="15%" align="right" valign="top" class="summary">
274      <span class="summary-type">int</span>
275    </td><td class="summary">
276        <a name="IN_DELETE"></a><span class="summary-name">IN_DELETE</span><br />
277      Subfile was deleted.
278    </td>
279  </tr>
280<tr>
281    <td width="15%" align="right" valign="top" class="summary">
282      <span class="summary-type">int</span>
283    </td><td class="summary">
284        <a name="IN_DELETE_SELF"></a><span class="summary-name">IN_DELETE_SELF</span><br />
285      Self (watched item itself) was deleted.
286    </td>
287  </tr>
288<tr>
289    <td width="15%" align="right" valign="top" class="summary">
290      <span class="summary-type">int</span>
291    </td><td class="summary">
292        <a href="pyinotify.EventsCodes-class.html#IN_DONT_FOLLOW" class="summary-name">IN_DONT_FOLLOW</a><br />
293      don't follow a symlink (new in kernel 2.6.15).
294    </td>
295  </tr>
296<tr>
297    <td width="15%" align="right" valign="top" class="summary">
298      <span class="summary-type">int</span>
299    </td><td class="summary">
300        <a name="IN_IGNORED"></a><span class="summary-name">IN_IGNORED</span><br />
301      File was ignored.
302    </td>
303  </tr>
304<tr>
305    <td width="15%" align="right" valign="top" class="summary">
306      <span class="summary-type">int</span>
307    </td><td class="summary">
308        <a name="IN_ISDIR"></a><span class="summary-name">IN_ISDIR</span><br />
309      Event occurred against dir.
310    </td>
311  </tr>
312<tr>
313    <td width="15%" align="right" valign="top" class="summary">
314      <span class="summary-type">int</span>
315    </td><td class="summary">
316        <a name="IN_MASK_ADD"></a><span class="summary-name">IN_MASK_ADD</span><br />
317      add to the mask of an already existing watch (new in kernel 2.6.14).
318    </td>
319  </tr>
320<tr>
321    <td width="15%" align="right" valign="top" class="summary">
322      <span class="summary-type">int</span>
323    </td><td class="summary">
324        <a name="IN_MODIFY"></a><span class="summary-name">IN_MODIFY</span><br />
325      File was modified.
326    </td>
327  </tr>
328<tr>
329    <td width="15%" align="right" valign="top" class="summary">
330      <span class="summary-type">int</span>
331    </td><td class="summary">
332        <a name="IN_MOVED_FROM"></a><span class="summary-name">IN_MOVED_FROM</span><br />
333      File was moved from X.
334    </td>
335  </tr>
336<tr>
337    <td width="15%" align="right" valign="top" class="summary">
338      <span class="summary-type">int</span>
339    </td><td class="summary">
340        <a name="IN_MOVED_TO"></a><span class="summary-name">IN_MOVED_TO</span><br />
341      File was moved to Y.
342    </td>
343  </tr>
344<tr>
345    <td width="15%" align="right" valign="top" class="summary">
346      <span class="summary-type">int</span>
347    </td><td class="summary">
348        <a name="IN_MOVE_SELF"></a><span class="summary-name">IN_MOVE_SELF</span><br />
349      Self (watched item itself) was moved.
350    </td>
351  </tr>
352<tr>
353    <td width="15%" align="right" valign="top" class="summary">
354      <span class="summary-type">int</span>
355    </td><td class="summary">
356        <a name="IN_ONESHOT"></a><span class="summary-name">IN_ONESHOT</span><br />
357      Only send event once.
358    </td>
359  </tr>
360<tr>
361    <td width="15%" align="right" valign="top" class="summary">
362      <span class="summary-type">int</span>
363    </td><td class="summary">
364        <a name="IN_ONLYDIR"></a><span class="summary-name">IN_ONLYDIR</span><br />
365      only watch the path if it is a directory (new in kernel 2.6.15).
366    </td>
367  </tr>
368<tr>
369    <td width="15%" align="right" valign="top" class="summary">
370      <span class="summary-type">int</span>
371    </td><td class="summary">
372        <a name="IN_OPEN"></a><span class="summary-name">IN_OPEN</span><br />
373      File was opened.
374    </td>
375  </tr>
376<tr>
377    <td width="15%" align="right" valign="top" class="summary">
378      <span class="summary-type">int</span>
379    </td><td class="summary">
380