Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / html / python / lib / mutex-objects.html
CommitLineData
920dae64
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="lib.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="lib.html" title='Python Library Reference' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="prev" href="module-mutex.html" />
13<link rel="parent" href="module-mutex.html" />
14<link rel="next" href="module-getpass.html" />
15<meta name='aesop' content='information' />
16<title>6.13.1 Mutex Objects </title>
17</head>
18<body>
19<DIV CLASS="navigation">
20<div id='top-navigation-panel' xml:id='top-navigation-panel'>
21<table align="center" width="100%" cellpadding="0" cellspacing="2">
22<tr>
23<td class='online-navigation'><a rel="prev" title="6.13 mutex "
24 href="module-mutex.html"><img src='../icons/previous.png'
25 border='0' height='32' alt='Previous Page' width='32' /></A></td>
26<td class='online-navigation'><a rel="parent" title="6.13 mutex "
27 href="module-mutex.html"><img src='../icons/up.png'
28 border='0' height='32' alt='Up One Level' width='32' /></A></td>
29<td class='online-navigation'><a rel="next" title="6.14 getpass "
30 href="module-getpass.html"><img src='../icons/next.png'
31 border='0' height='32' alt='Next Page' width='32' /></A></td>
32<td align="center" width="100%">Python Library Reference</td>
33<td class='online-navigation'><a rel="contents" title="Table of Contents"
34 href="contents.html"><img src='../icons/contents.png'
35 border='0' height='32' alt='Contents' width='32' /></A></td>
36<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
37 border='0' height='32' alt='Module Index' width='32' /></a></td>
38<td class='online-navigation'><a rel="index" title="Index"
39 href="genindex.html"><img src='../icons/index.png'
40 border='0' height='32' alt='Index' width='32' /></A></td>
41</tr></table>
42<div class='online-navigation'>
43<b class="navlabel">Previous:</b>
44<a class="sectref" rel="prev" href="module-mutex.html">6.13 mutex </A>
45<b class="navlabel">Up:</b>
46<a class="sectref" rel="parent" href="module-mutex.html">6.13 mutex </A>
47<b class="navlabel">Next:</b>
48<a class="sectref" rel="next" href="module-getpass.html">6.14 getpass </A>
49</div>
50<hr /></div>
51</DIV>
52<!--End of Navigation Panel-->
53
54<H2><A NAME="SECTION0081310000000000000000"></A><A NAME="mutex-objects"></A>
55<BR>
566.13.1 Mutex Objects
57</H2>
58
59<P>
60<tt class="class">mutex</tt> objects have following methods:
61
62<P>
63<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
64 <td><nobr><b><tt id='l2h-1989' xml:id='l2h-1989' class="method">test</tt></b>(</nobr></td>
65 <td><var></var>)</td></tr></table></dt>
66<dd>
67Check whether the mutex is locked.
68</dl>
69
70<P>
71<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
72 <td><nobr><b><tt id='l2h-1990' xml:id='l2h-1990' class="method">testandset</tt></b>(</nobr></td>
73 <td><var></var>)</td></tr></table></dt>
74<dd>
75``Atomic'' test-and-set, grab the lock if it is not set,
76and return <code>True</code>, otherwise, return <code>False</code>.
77</dl>
78
79<P>
80<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
81 <td><nobr><b><tt id='l2h-1991' xml:id='l2h-1991' class="method">lock</tt></b>(</nobr></td>
82 <td><var>function, argument</var>)</td></tr></table></dt>
83<dd>
84Execute <code><var>function</var>(<var>argument</var>)</code>, unless the mutex is locked.
85In the case it is locked, place the function and argument on the queue.
86See <tt class="method">unlock</tt> for explanation of when
87<code><var>function</var>(<var>argument</var>)</code> is executed in that case.
88</dl>
89
90<P>
91<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
92 <td><nobr><b><tt id='l2h-1992' xml:id='l2h-1992' class="method">unlock</tt></b>(</nobr></td>
93 <td><var></var>)</td></tr></table></dt>
94<dd>
95Unlock the mutex if queue is empty, otherwise execute the first element
96in the queue.
97</dl>
98
99<DIV CLASS="navigation">
100<div class='online-navigation'>
101<p></p><hr />
102<table align="center" width="100%" cellpadding="0" cellspacing="2">
103<tr>
104<td class='online-navigation'><a rel="prev" title="6.13 mutex "
105 href="module-mutex.html"><img src='../icons/previous.png'
106 border='0' height='32' alt='Previous Page' width='32' /></A></td>
107<td class='online-navigation'><a rel="parent" title="6.13 mutex "
108 href="module-mutex.html"><img src='../icons/up.png'
109 border='0' height='32' alt='Up One Level' width='32' /></A></td>
110<td class='online-navigation'><a rel="next" title="6.14 getpass "
111 href="module-getpass.html"><img src='../icons/next.png'
112 border='0' height='32' alt='Next Page' width='32' /></A></td>
113<td align="center" width="100%">Python Library Reference</td>
114<td class='online-navigation'><a rel="contents" title="Table of Contents"
115 href="contents.html"><img src='../icons/contents.png'
116 border='0' height='32' alt='Contents' width='32' /></A></td>
117<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
118 border='0' height='32' alt='Module Index' width='32' /></a></td>
119<td class='online-navigation'><a rel="index" title="Index"
120 href="genindex.html"><img src='../icons/index.png'
121 border='0' height='32' alt='Index' width='32' /></A></td>
122</tr></table>
123<div class='online-navigation'>
124<b class="navlabel">Previous:</b>
125<a class="sectref" rel="prev" href="module-mutex.html">6.13 mutex </A>
126<b class="navlabel">Up:</b>
127<a class="sectref" rel="parent" href="module-mutex.html">6.13 mutex </A>
128<b class="navlabel">Next:</b>
129<a class="sectref" rel="next" href="module-getpass.html">6.14 getpass </A>
130</div>
131</div>
132<hr />
133<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
134</DIV>
135<!--End of Navigation Panel-->
136<ADDRESS>
137See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
138</ADDRESS>
139</BODY>
140</HTML>