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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: THREADWAIT Wait on a thread to complete execution</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('thread_threadwait.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">THREADWAIT Wait on a thread to complete execution </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_thread.html">FreeMat Threads</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>The <code>threadwait</code> function waits for the given thread to complete execution, and stops execution of the current thread (the one calling <code>threadwait</code>) until the given thread completes. The syntax for its use is </p>
<pre class="fragment"> success = threadwait(handle)
</pre><p> where <code>handle</code> is the value returned by <code>threadnew</code> and <code>success</code> is a <code>logical</code> vaariable that will be <code>1</code> if the wait was successful or <code>0</code> if the wait times out. By default, the wait is indefinite. It is better to use the following form of the function </p>
<pre class="fragment"> success = threadwait(handle,timeout)
</pre><p> where <code>timeout</code> is the amount of time (in milliseconds) for the <code>threadwait</code> function to wait before a timeout occurs. If the <code>threadwait</code> function succeeds, then the return value is a logical <code>1</code>, and if it fails, the return value is a logical <code>0</code>. Note that you can call <code>threadwait</code> multiple times on a thread, and if the thread is completed, each one will succeed. </p>
<h1><a class="anchor" id="Example"></a>
Example</h1>
<p>Here we lauch the <code>sleep</code> function in a thread with a time delay of 10 seconds. This means that the thread function will not complete until 10 seconds have elapsed. When we call <code>threadwait</code> on this thread with a short timeout, it fails, but not when the timeout is long enough to capture the end of the function call.</p>
<pre class="fragment">--> a = threadnew;
--> threadstart(a,'sleep',0,10); % start a thread that will sleep for 10
--> threadwait(a,2000) % 2 second wait is not long enough
ans =
0
--> threadwait(a,10000) % 10 second wait is long enough
ans =
1
--> threadfree(a)
</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_thread.html">FreeMat Threads</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:29 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
