Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 934576d7592d78c5ae61a4d932f39d0e5745d12e / . / TestON / Documentation / TestON_Document / TestON.core.Thread.Thread-class.html
blob: 6e0bcd36a2a0be51baaa42ce0106992f9d9ecc00 [file] [log] [blame]
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]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>TestON.core.Thread.Thread</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="TestON-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 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.core-module.html">Package&nbsp;core</a> ::
47 <a href="TestON.core.Thread-module.html">Module&nbsp;Thread</a> ::
48 Class&nbsp;Thread
49 </span>
50 </td>
51 <td>
52 <table cellpadding="0" cellspacing="0">
53 <!-- hide/show private -->
54 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
56 <tr><td align="right"><span class="options"
57 >[<a href="frames.html" target="_top">frames</a
58 >]&nbsp;|&nbsp;<a href="TestON.core.Thread.Thread-class.html"
59 target="_top">no&nbsp;frames</a>]</span></td></tr>
60 </table>
61 </td>
62 </tr>
63</table>
64<!-- ==================== CLASS DESCRIPTION ==================== -->
65<h1 class="epydoc">Class Thread</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.core.Thread-pysrc.html#Thread">source&nbsp;code</a></span></p>
66<center>
67<center> <map id="class_hierarchy_for_thread" name="class_hierarchy_for_thread">
68<area shape="rect" id="node1" href="TestON.core.Thread.Thread-class.html" title="Thread" alt="" coords="41,118,103,143"/>
69<area shape="rect" id="node2" href="javascript:void(0);" title="threading.Thread" alt="" coords="13,62,131,87"/>
70<area shape="rect" id="node3" href="javascript:void(0);" title="threading._Verbose" alt="" coords="5,6,139,31"/>
71</map>
72 <img src="class_hierarchy_for_thread.gif" alt='' usemap="#class_hierarchy_for_thread" ismap="ismap" class="graph-without-title" />
73</center>
74</center>
75<hr />
76<!-- ==================== INSTANCE METHODS ==================== -->
77<a name="section-InstanceMethods"></a>
78<table class="summary" border="1" cellpadding="3"
79 cellspacing="0" width="100%" bgcolor="white">
80<tr bgcolor="#70b0f0" class="table-header">
81 <td colspan="2" class="table-header">
82 <table border="0" cellpadding="0" cellspacing="0" width="100%">
83 <tr valign="top">
84 <td align="left"><span class="table-header">Instance Methods</span></td>
85 <td align="right" valign="top"
86 ><span class="options">[<a href="#section-InstanceMethods"
87 class="privatelink" onclick="toggle_private();"
88 >hide private</a>]</span></td>
89 </tr>
90 </table>
91 </td>
92</tr>
93<tr>
94 <td width="15%" align="right" valign="top" class="summary">
95 <span class="summary-type">&nbsp;</span>
96 </td><td class="summary">
97 <table width="100%" cellpadding="0" cellspacing="0" border="0">
98 <tr>
99 <td><span class="summary-sig"><a href="TestON.core.Thread.Thread-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
100 <span class="summary-sig-arg">target</span>=<span class="summary-sig-default">None</span>,
101 <span class="summary-sig-arg">threadID</span>=<span class="summary-sig-default">None</span>,
102 <span class="summary-sig-arg">name</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
103 <span class="summary-sig-arg">args</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
104 <span class="summary-sig-arg">kwargs</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span><br />
105 This constructor should always be called with keyword arguments.</td>
106 <td align="right" valign="top">
107 <span class="codelink"><a href="TestON.core.Thread-pysrc.html#Thread.__init__">source&nbsp;code</a></span>
108
109 </td>
110 </tr>
111 </table>
112
113 </td>
114 </tr>
115<tr>
116 <td width="15%" align="right" valign="top" class="summary">
117 <span class="summary-type">&nbsp;</span>
118 </td><td class="summary">
119 <table width="100%" cellpadding="0" cellspacing="0" border="0">
120 <tr>
121 <td><span class="summary-sig"><a href="TestON.core.Thread.Thread-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span><br />
122 Method representing the thread's activity.</td>
123 <td align="right" valign="top">
124 <span class="codelink"><a href="TestON.core.Thread-pysrc.html#Thread.run">source&nbsp;code</a></span>
125
126 </td>
127 </tr>
128 </table>
129
130 </td>
131 </tr>
132 <tr>
133 <td colspan="2" class="summary">
134 <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
135 <code>__repr__</code>,
136 <code>getName</code>,
137 <code>isAlive</code>,
138 <code>isDaemon</code>,
139 <code>is_alive</code>,
140 <code>join</code>,
141 <code>setDaemon</code>,
142 <code>setName</code>,
143 <code>start</code>
144 </p>
145 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
146 <code>_reset_internal_locks</code>,
147 <code>_set_daemon</code>,
148 <code>_set_ident</code>
149 </p></div>
150 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading._Verbose</code></b> (private):
151 <code>_note</code>
152 </p></div>
153 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
154 <code>__delattr__</code>,
155 <code>__format__</code>,
156 <code>__getattribute__</code>,
157 <code>__hash__</code>,
158 <code>__new__</code>,
159 <code>__reduce__</code>,
160 <code>__reduce_ex__</code>,
161 <code>__setattr__</code>,
162 <code>__sizeof__</code>,
163 <code>__str__</code>,
164 <code>__subclasshook__</code>
165 </p>
166 </td>
167 </tr>
168</table>
169<!-- ==================== PROPERTIES ==================== -->
170<a name="section-Properties"></a>
171<table class="summary" border="1" cellpadding="3"
172 cellspacing="0" width="100%" bgcolor="white">
173<tr bgcolor="#70b0f0" class="table-header">
174 <td colspan="2" class="table-header">
175 <table border="0" cellpadding="0" cellspacing="0" width="100%">
176 <tr valign="top">
177 <td align="left"><span class="table-header">Properties</span></td>
178 <td align="right" valign="top"
179 ><span class="options">[<a href="#section-Properties"
180 class="privatelink" onclick="toggle_private();"
181 >hide private</a>]</span></td>
182 </tr>
183 </table>
184 </td>
185</tr>
186 <tr>
187 <td colspan="2" class="summary">
188 <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
189 <code>daemon</code>,
190 <code>ident</code>,
191 <code>name</code>
192 </p>
193 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
194 <code>_block</code>
195 </p></div>
196 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
197 <code>__class__</code>
198 </p>
199 </td>
200 </tr>
201</table>
202<!-- ==================== METHOD DETAILS ==================== -->
203<a name="section-MethodDetails"></a>
204<table class="details" border="1" cellpadding="3"
205 cellspacing="0" width="100%" bgcolor="white">
206<tr bgcolor="#70b0f0" class="table-header">
207 <td colspan="2" class="table-header">
208 <table border="0" cellpadding="0" cellspacing="0" width="100%">
209 <tr valign="top">
210 <td align="left"><span class="table-header">Method Details</span></td>
211 <td align="right" valign="top"
212 ><span class="options">[<a href="#section-MethodDetails"
213 class="privatelink" onclick="toggle_private();"
214 >hide private</a>]</span></td>
215 </tr>
216 </table>
217 </td>
218</tr>
219</table>
220<a name="__init__"></a>
221<div>
222<table class="details" border="1" cellpadding="3"
223 cellspacing="0" width="100%" bgcolor="white">
224<tr><td>
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr valign="top"><td>
227 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
228 <span class="sig-arg">target</span>=<span class="sig-default">None</span>,
229 <span class="sig-arg">threadID</span>=<span class="sig-default">None</span>,
230 <span class="sig-arg">name</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
231 <span class="sig-arg">args</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
232 <span class="sig-arg">kwargs</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
233 <br /><em class="fname">(Constructor)</em>
234 </h3>
235 </td><td align="right" valign="top"
236 ><span class="codelink"><a href="TestON.core.Thread-pysrc.html#Thread.__init__">source&nbsp;code</a></span>&nbsp;
237 </td>
238 </tr></table>
239
240 <p>This constructor should always be called with keyword arguments.
241 Arguments are:</p>
242 <p>*group* should be None; reserved for future extension when a
243 ThreadGroup class is implemented.</p>
244 <p>*target* is the callable object to be invoked by the run() method.
245 Defaults to None, meaning nothing is called.</p>
246 <p>*name* is the thread name. By default, a unique name is constructed of
247 the form &quot;Thread-N&quot; where N is a small decimal number.</p>
248 <p>*args* is the argument tuple for the target invocation. Defaults to
249 ().</p>
250 <p>*kwargs* is a dictionary of keyword arguments for the target
251 invocation. Defaults to {}.</p>
252 <p>If a subclass overrides the constructor, it must make sure to invoke
253 the base class constructor (Thread.__init__()) before doing anything else
254 to the thread.</p>
255 <dl class="fields">
256 <dt>Overrides:
257 object.__init__
258 <dd><em class="note">(inherited documentation)</em></dd>
259 </dt>
260 </dl>
261</td></tr></table>
262</div>
263<a name="run"></a>
264<div>
265<table class="details" border="1" cellpadding="3"
266 cellspacing="0" width="100%" bgcolor="white">
267<tr><td>
268 <table width="100%" cellpadding="0" cellspacing="0" border="0">
269 <tr valign="top"><td>
270 <h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
271 </h3>
272 </td><td align="right" valign="top"
273 ><span class="codelink"><a href="TestON.core.Thread-pysrc.html#Thread.run">source&nbsp;code</a></span>&nbsp;
274 </td>
275 </tr></table>
276
277 <p>Method representing the thread's activity.</p>
278 <p>You may override this method in a subclass. The standard run() method
279 invokes the callable object passed to the object's constructor as the
280 target argument, if any, with sequential and keyword arguments taken from
281 the args and kwargs arguments, respectively.</p>
282 <dl class="fields">
283 <dt>Overrides:
284 threading.Thread.run
285 <dd><em class="note">(inherited documentation)</em></dd>
286 </dt>
287 </dl>
288</td></tr></table>
289</div>
290<br />
291<!-- ==================== NAVIGATION BAR ==================== -->
292<table class="navbar" border="0" width="100%" cellpadding="0"
293 bgcolor="#a0c0ff" cellspacing="0">
294 <tr valign="middle">
295 <!-- Home link -->
296 <th>&nbsp;&nbsp;&nbsp;<a
297 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
298
299 <!-- Tree link -->
300 <th>&nbsp;&nbsp;&nbsp;<a
301 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
302
303 <!-- Index link -->
304 <th>&nbsp;&nbsp;&nbsp;<a
305 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
306
307 <!-- Help link -->
308 <th>&nbsp;&nbsp;&nbsp;<a
309 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
310
311 <!-- Project homepage -->
312 <th class="navbar" align="right" width="100%">
313 <table border="0" cellpadding="0" cellspacing="0">
314 <tr><th class="navbar" align="center"
315 >TestON</th>
316 </tr></table></th>
317 </tr>
318</table>
319<table border="0" cellpadding="0" cellspacing="0" width="100%%">
320 <tr>
321 <td align="left" class="footer">
322 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
323 </td>
324 <td align="right" class="footer">
325 <a target="mainFrame" href="http://epydoc.sourceforge.net"
326 >http://epydoc.sourceforge.net</a>
327 </td>
328 </tr>
329</table>
330
331<script type="text/javascript">
332 <!--
333 // Private objects are initially displayed (because if
334 // javascript is turned off then we want them to be
335 // visible); but by default, we want to hide them. So hide
336 // them unless we have a cookie that says to show them.
337 checkCookie();
338 // -->
339</script>
340</body>
341</html>