← Back to branch summary

~openerp-commiter/openobject-addons/stable-sja-branch

« back to all changes in this revision

Viewing changes to etl/doc/threading._Timer-class.html

  • Committer: sja-axelor
  • Date: 2009-10-13 09:52:57 UTC
  • Revision ID: suniljagyasi@gmail.com-20091013095257-8u26ww0r20z9y6ey
add

Show diffs side-by-side

added added

removed removed

Lines of Context:
etl/doc/threading._Timer-class.html
 
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>threading._Timer</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="etl-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
        threading ::
 
41
        _Timer ::
 
42
        Class&nbsp;_Timer
 
43
      </span>
 
44
    </td>
 
45
    <td>
 
46
      <table cellpadding="0" cellspacing="0">
 
47
        <!-- hide/show private -->
 
48
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 
49
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 
50
        <tr><td align="right"><span class="options"
 
51
            >[<a href="frames.html" target="_top">frames</a
 
52
            >]&nbsp;|&nbsp;<a href="threading._Timer-class.html"
 
53
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
54
      </table>
 
55
    </td>
 
56
  </tr>
 
57
</table>
 
58
<!-- ==================== CLASS DESCRIPTION ==================== -->
 
59
<h1 class="epydoc">Class _Timer</h1><span class="codelink"><a href="threading-pysrc.html#_Timer">source&nbsp;code</a></span><br /><br />
 
60
<pre class="base-tree">
 
61
object --+        
 
62
         |        
 
63
  <a href="threading._Verbose-class.html">_Verbose</a> --+    
 
64
             |    
 
65
        <a href="threading.Thread-class.html">Thread</a> --+
 
66
                 |
 
67
                <strong class="uidshort">_Timer</strong>
 
68
</pre>
 
69
 
 
70
<hr />
 
71
<p>Call a function after a specified number of seconds:</p>
 
72
  t = Timer(30.0, f, args=[], kwargs={}) t.start() t.cancel() # stop the
 
73
  timer's action if it's still waiting<br /><br />
 
74
 
 
75
<!-- ==================== INSTANCE METHODS ==================== -->
 
76
<a name="section-InstanceMethods"></a>
 
77
<table class="summary" border="1" cellpadding="3"
 
78
       cellspacing="0" width="100%" bgcolor="white">
 
79
<tr bgcolor="#70b0f0" class="table-header">
 
80
  <td colspan="2" class="table-header">
 
81
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
82
      <tr valign="top">
 
83
        <td align="left"><span class="table-header">Instance Methods</span></td>
 
84
        <td align="right" valign="top"
 
85
         ><span class="options">[<a href="#section-InstanceMethods"
 
86
         class="privatelink" onclick="toggle_private();"
 
87
         >hide private</a>]</span></td>
 
88
      </tr>
 
89
    </table>
 
90
  </td>
 
91
</tr>
 
92
<tr>
 
93
    <td width="15%" align="right" valign="top" class="summary">
 
94
      <span class="summary-type">&nbsp;</span>
 
95
    </td><td class="summary">
 
96
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
97
        <tr>
 
98
          <td><span class="summary-sig"><a href="threading._Timer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 
99
        <span class="summary-sig-arg">interval</span>,
 
100
        <span class="summary-sig-arg">function</span>,
 
101
        <span class="summary-sig-arg">args</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
 
102
        <span class="summary-sig-arg">kwargs</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span></td>
 
103
          <td align="right" valign="top">
 
104
            <span class="codelink"><a href="threading-pysrc.html#_Timer.__init__">source&nbsp;code</a></span>
 
105
            
 
106
          </td>
 
107
        </tr>
 
108
      </table>
 
109
      
 
110
    </td>
 
111
  </tr>
 
112
<tr>
 
113
    <td width="15%" align="right" valign="top" class="summary">
 
114
      <span class="summary-type">&nbsp;</span>
 
115
    </td><td class="summary">
 
116
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
117
        <tr>
 
118
          <td><span class="summary-sig"><a name="cancel"></a><span class="summary-sig-name">cancel</span>(<span class="summary-sig-arg">self</span>)</span><br />
 
119
      Stop the timer if it hasn't finished yet</td>
 
120
          <td align="right" valign="top">
 
121
            <span class="codelink"><a href="threading-pysrc.html#_Timer.cancel">source&nbsp;code</a></span>
 
122
            
 
123
          </td>
 
124
        </tr>
 
125
      </table>
 
126
      
 
127
    </td>
 
128
  </tr>
 
129
<tr>
 
130
    <td width="15%" align="right" valign="top" class="summary">
 
131
      <span class="summary-type">&nbsp;</span>
 
132
    </td><td class="summary">
 
133
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
134
        <tr>
 
135
          <td><span class="summary-sig"><a href="threading._Timer-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span></td>
 
136
          <td align="right" valign="top">
 
137
            <span class="codelink"><a href="threading-pysrc.html#_Timer.run">source&nbsp;code</a></span>
 
138
            
 
139
          </td>
 
140
        </tr>
 
141
      </table>
 
142
      
 
143
    </td>
 
144
  </tr>
 
145
  <tr>
 
146
    <td colspan="2" class="summary">
 
147
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="threading.Thread-class.html">Thread</a></code></b>:
 
148
      <code><a href="threading.Thread-class.html#__repr__">__repr__</a></code>,
 
149
      <code><a href="threading.Thread-class.html#getName">getName</a></code>,
 
150
      <code><a href="threading.Thread-class.html#isAlive">isAlive</a></code>,
 
151
      <code><a href="threading.Thread-class.html#isDaemon">isDaemon</a></code>,
 
152
      <code><a href="threading.Thread-class.html#join">join</a></code>,
 
153
      <code><a href="threading.Thread-class.html#setDaemon">setDaemon</a></code>,
 
154
      <code><a href="threading.Thread-class.html#setName">setName</a></code>,
 
155
      <code><a href="threading.Thread-class.html#start">start</a></code>
 
156
      </p>
 
157
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="threading.Thread-class.html">Thread</a></code></b> (private):
 
158
      <code><a href="threading.Thread-class.html#_set_daemon">_set_daemon</a></code>
 
159
      </p></div>
 
160
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="threading._Verbose-class.html">_Verbose</a></code></b> (private):
 
161
      <code><a href="threading._Verbose-class.html#_note">_note</a></code>
 
162
      </p></div>
 
163
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
164
      <code>__delattr__</code>,
 
165
      <code>__getattribute__</code>,
 
166
      <code>__hash__</code>,
 
167
      <code>__new__</code>,
 
168
      <code>__reduce__</code>,
 
169
      <code>__reduce_ex__</code>,
 
170
      <code>__setattr__</code>,
 
171
      <code>__str__</code>
 
172
      </p>
 
173
    </td>
 
174
  </tr>
 
175
</table>
 
176
<!-- ==================== PROPERTIES ==================== -->
 
177
<a name="section-Properties"></a>
 
178
<table class="summary" border="1" cellpadding="3"
 
179
       cellspacing="0" width="100%" bgcolor="white">
 
180
<tr bgcolor="#70b0f0" class="table-header">
 
181
  <td colspan="2" class="table-header">
 
182
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
183
      <tr valign="top">
 
184
        <td align="left"><span class="table-header">Properties</span></td>
 
185
        <td align="right" valign="top"
 
186
         ><span class="options">[<a href="#section-Properties"
 
187
         class="privatelink" onclick="toggle_private();"
 
188
         >hide private</a>]</span></td>
 
189
      </tr>
 
190
    </table>
 
191
  </td>
 
192
</tr>
 
193
  <tr>
 
194
    <td colspan="2" class="summary">
 
195
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
196
      <code>__class__</code>
 
197
      </p>
 
198
    </td>
 
199
  </tr>
 
200
</table>
 
201
<!-- ==================== METHOD DETAILS ==================== -->
 
202
<a name="section-MethodDetails"></a>
 
203
<table class="details" border="1" cellpadding="3"
 
204
       cellspacing="0" width="100%" bgcolor="white">
 
205
<tr bgcolor="#70b0f0" class="table-header">
 
206
  <td colspan="2" class="table-header">
 
207
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
208
      <tr valign="top">
 
209
        <td align="left"><span class="table-header">Method Details</span></td>
 
210
        <td align="right" valign="top"
 
211
         ><span class="options">[<a href="#section-MethodDetails"
 
212
         class="privatelink" onclick="toggle_private();"
 
213
         >hide private</a>]</span></td>
 
214
      </tr>
 
215
    </table>
 
216
  </td>
 
217
</tr>
 
218
</table>
 
219
<a name="__init__"></a>
 
220
<div>
 
221
<table class="details" border="1" cellpadding="3"
 
222
       cellspacing="0" width="100%" bgcolor="white">
 
223
<tr><td>
 
224
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
225
  <tr valign="top"><td>
 
226
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
227
        <span class="sig-arg">interval</span>,
 
228
        <span class="sig-arg">function</span>,
 
229
        <span class="sig-arg">args</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
 
230
        <span class="sig-arg">kwargs</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
 
231
    <br /><em class="fname">(Constructor)</em>
 
232
  </h3>
 
233
  </td><td align="right" valign="top"
 
234
    ><span class="codelink"><a href="threading-pysrc.html#_Timer.__init__">source&nbsp;code</a></span>&nbsp;
 
235
    </td>
 
236
  </table>
 
237
  
 
238
  
 
239
  <dl class="fields">
 
240
    <dt>Overrides:
 
241
      Thread.__init__
 
242
    </dt>
 
243
  </dl>
 
244
</td></tr></table>
 
245
</div>
 
246
<a name="run"></a>
 
247
<div>
 
248
<table class="details" border="1" cellpadding="3"
 
249
       cellspacing="0" width="100%" bgcolor="white">
 
250
<tr><td>
 
251
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
252
  <tr valign="top"><td>
 
253
  <h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
 
254
  </h3>
 
255
  </td><td align="right" valign="top"
 
256
    ><span class="codelink"><a href="threading-pysrc.html#_Timer.run">source&nbsp;code</a></span>&nbsp;
 
257
    </td>
 
258
  </table>
 
259
  
 
260
  
 
261
  <dl class="fields">
 
262
    <dt>Overrides:
 
263
      Thread.run
 
264
    </dt>
 
265
  </dl>
 
266
</td></tr></table>
 
267
</div>
 
268
<br />
 
269
<!-- ==================== NAVIGATION BAR ==================== -->
 
270
<table class="navbar" border="0" width="100%" cellpadding="0"
 
271
       bgcolor="#a0c0ff" cellspacing="0">
 
272
  <tr valign="middle">
 
273
  <!-- Home link -->
 
274
      <th>&nbsp;&nbsp;&nbsp;<a
 
275
        href="etl-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
276
 
 
277
  <!-- Tree link -->
 
278
      <th>&nbsp;&nbsp;&nbsp;<a
 
279
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
280
 
 
281
  <!-- Index link -->
 
282
      <th>&nbsp;&nbsp;&nbsp;<a
 
283
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
284
 
 
285
  <!-- Help link -->
 
286
      <th>&nbsp;&nbsp;&nbsp;<a
 
287
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
288
 
 
289
      <th class="navbar" width="100%"></th>
 
290
  </tr>
 
291
</table>
 
292
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
293
  <tr>
 
294
    <td align="left" class="footer">
 
295
    Generated by Epydoc 3.0beta1 on Wed Apr 29 20:37:23 2009
 
296
    </td>
 
297
    <td align="right" class="footer">
 
298
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
299
    </td>
 
300
  </tr>
 
301
</table>
 
302
 
 
303
<script type="text/javascript">
 
304
  <!--
 
305
  // Private objects are initially displayed (because if
 
306
  // javascript is turned off then we want them to be
 
307
  // visible); but by default, we want to hide them.  So hide
 
308
  // them unless we have a cookie that says to show them.
 
309
  checkCookie()
 
310
  // -->
 
311
</script>
 
312
  
 
313
</body>
 
314
</html>