summaryrefslogtreecommitdiff
path: root/class-tree.html
blob: 5286f9ebf667f99b143767069b4a88f88263b4ff (plain)
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
<?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>Class Hierarchy</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>&nbsp;&nbsp;&nbsp;<a
        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">&nbsp;</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&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="class-tree.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<center><b>
 [ <a href="module-tree.html">Module Hierarchy</a>
 | <a href="class-tree.html">Class Hierarchy</a> ]
</b></center><br />
<h1 class="epydoc">Class Hierarchy</h1>
<ul class="nomargin-top">
    <li> <strong class="uidlink">asyncore.dispatcher</strong>
    <ul>
    <li> <strong class="uidlink">asyncore.file_dispatcher</strong>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.AsyncNotifier-class.html">pyinotify.AsyncNotifier</a></strong>:
      <em class="summary">This notifier inherits from asyncore.file_dispatcher in order to be
        able to use pyinotify along with the asyncore framework.</em>
    </li>
    </ul>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink">object</strong>:
      <em class="summary">The most base type</em>
    <ul>
    <li> <strong class="uidlink">exceptions.BaseException</strong>:
      <em class="summary">Common base class for all exceptions</em>
    <ul>
    <li> <strong class="uidlink">exceptions.Exception</strong>:
      <em class="summary">Common base class for all non-exit exceptions.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.PyinotifyError-class.html">pyinotify.PyinotifyError</a></strong>:
      <em class="summary">Indicates exceptions raised by a Pyinotify class.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.InotifyBindingNotFoundError-class.html">pyinotify.InotifyBindingNotFoundError</a></strong>:
      <em class="summary">Raised when no inotify support couldn't be found.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.NotifierError-class.html">pyinotify.NotifierError</a></strong>:
      <em class="summary">Notifier Exception.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.ProcessEventError-class.html">pyinotify.ProcessEventError</a></strong>:
      <em class="summary">ProcessEventError Exception.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.UnsupportedPythonVersionError-class.html">pyinotify.UnsupportedPythonVersionError</a></strong>:
      <em class="summary">Raised on unsupported Python versions.</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.WatchManagerError-class.html">pyinotify.WatchManagerError</a></strong>:
      <em class="summary">WatchManager Exception.</em>
    </li>
    </ul>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.EventsCodes-class.html">pyinotify.EventsCodes</a></strong>:
      <em class="summary">Set of codes corresponding to each kind of events.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.ExcludeFilter-class.html">pyinotify.ExcludeFilter</a></strong>:
      <em class="summary">ExcludeFilter is an exclusion filter.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.INotifyWrapper-class.html">pyinotify.INotifyWrapper</a></strong>:
      <em class="summary">Abstract class wrapping access to inotify's functions.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify._CtypesLibcINotifyWrapper-class.html" onclick="show_private();">pyinotify._CtypesLibcINotifyWrapper</a></strong>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify._INotifySyscallsWrapper-class.html" onclick="show_private();">pyinotify._INotifySyscallsWrapper</a></strong>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.Notifier-class.html">pyinotify.Notifier</a></strong>:
      <em class="summary">Read notifications, process events.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.AsyncNotifier-class.html">pyinotify.AsyncNotifier</a></strong>:
      <em class="summary">This notifier inherits from asyncore.file_dispatcher in order to be
        able to use pyinotify along with the asyncore framework.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.AsyncioNotifier-class.html">pyinotify.AsyncioNotifier</a></strong>:
      <em class="summary">asyncio/trollius event loop adapter.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.ThreadedNotifier-class.html">pyinotify.ThreadedNotifier</a></strong>:
      <em class="summary">This notifier inherits from threading.Thread for instanciating a 
        separate thread, and also inherits from Notifier, because it is a 
        threaded notifier.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.TornadoAsyncNotifier-class.html">pyinotify.TornadoAsyncNotifier</a></strong>:
      <em class="summary">Tornado ioloop adapter.</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.ProcINotify-class.html">pyinotify.ProcINotify</a></strong>:
      <em class="summary">Access (read, write) inotify's variables through /proc/sys/.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.RawOutputFormat-class.html">pyinotify.RawOutputFormat</a></strong>:
      <em class="summary">Format string representations.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.ColoredOutputFormat-class.html">pyinotify.ColoredOutputFormat</a></strong>:
      <em class="summary">Format colored string representations.</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.Watch-class.html">pyinotify.Watch</a></strong>:
      <em class="summary">Represent a watch, i.e.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.WatchManager-class.html">pyinotify.WatchManager</a></strong>:
      <em class="summary">Provide operations for watching files and directories.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify._Event-class.html" onclick="show_private();">pyinotify._Event</a></strong>:
      <em class="summary">Event structure, represent events raised by the system.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.Event-class.html">pyinotify.Event</a></strong>:
      <em class="summary">This class contains all the useful informations about the observed 
        event.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify._RawEvent-class.html" onclick="show_private();">pyinotify._RawEvent</a></strong>:
      <em class="summary">Raw event, it contains only the informations provided by the 
        system.</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify._ProcessEvent-class.html" onclick="show_private();">pyinotify._ProcessEvent</a></strong>:
      <em class="summary">Abstract processing event class.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.ProcessEvent-class.html">pyinotify.ProcessEvent</a></strong>:
      <em class="summary">Process events objects, can be specialized via subclassing, thus 
        its behavior can be overriden:</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.ChainIfTrue-class.html">pyinotify.ChainIfTrue</a></strong>:
      <em class="summary">Makes conditional chaining depending on the result of the nested 
        processing instance.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.PrintAllEvents-class.html">pyinotify.PrintAllEvents</a></strong>:
      <em class="summary">Dummy class used to print events strings representations.</em>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify.Stats-class.html">pyinotify.Stats</a></strong>:
      <em class="summary">Compute and display trivial statistics about processed events.</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyinotify._SysProcessEvent-class.html" onclick="show_private();">pyinotify._SysProcessEvent</a></strong>:
      <em class="summary">There is three kind of processing according to each event:</em>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink">threading._Verbose</strong>
    <ul>
    <li> <strong class="uidlink">threading.Thread</strong>:
      <em class="summary">A class that represents a thread of control.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyinotify.ThreadedNotifier-class.html">pyinotify.ThreadedNotifier</a></strong>:
      <em class="summary">This notifier inherits from threading.Thread for instanciating a 
        separate thread, and also inherits from Notifier, because it is a 
        threaded notifier.</em>
    </li>
    </ul>
    </li>
    </ul>
    </li>
    </ul>
    </li>
</ul>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pyinotify-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>