<!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/html; charset=utf-8" />
<title>9.9. mutex — Mutual exclusion support — Python v2.6.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.5',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v2.6.5 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python v2.6.5 documentation" href="../index.html" />
<link rel="up" title="9. Data Types" href="datatypes.html" />
<link rel="next" title="9.10. queue — A synchronized queue class" href="queue.html" />
<link rel="prev" title="9.8. sched — Event scheduler" href="sched.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="queue.html" title="9.10. queue — A synchronized queue class"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="sched.html" title="9.8. sched — Event scheduler"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="datatypes.html" accesskey="U">9. Data Types</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-mutex">
<h1>9.9. <tt class="xref docutils literal"><span class="pre">mutex</span></tt> — Mutual exclusion support<a class="headerlink" href="#module-mutex" title="Permalink to this headline">¶</a></h1>
<p class="deprecated">
<span class="versionmodified">Deprecated since version The: </span><tt class="xref docutils literal"><span class="pre">mutex</span></tt> module has been removed in Python 3.0.</p>
<p>The <tt class="xref docutils literal"><span class="pre">mutex</span></tt> module defines a class that allows mutual-exclusion via
acquiring and releasing locks. It does not require (or imply)
<a title="Higher-level threading interface." class="reference external" href="threading.html#module-threading"><tt class="xref docutils literal"><span class="pre">threading</span></tt></a> or multi-tasking, though it could be useful for those
purposes.</p>
<p>The <tt class="xref docutils literal"><span class="pre">mutex</span></tt> module defines the following class:</p>
<dl class="class">
<dt id="mutex.mutex">
<em class="property">class </em><tt class="descclassname">mutex.</tt><tt class="descname">mutex</tt><a class="headerlink" href="#mutex.mutex" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new (unlocked) mutex.</p>
<p>A mutex has two pieces of state — a “locked” bit and a queue. When the mutex
is not locked, the queue is empty. Otherwise, the queue contains zero or more
<tt class="docutils literal"><span class="pre">(function,</span> <span class="pre">argument)</span></tt> pairs representing functions (or methods) waiting to
acquire the lock. When the mutex is unlocked while the queue is not empty, the
first queue entry is removed and its <tt class="docutils literal"><span class="pre">function(argument)</span></tt> pair called,
implying it now has the lock.</p>
<p>Of course, no multi-threading is implied – hence the funny interface for
<a title="mutex.mutex.lock" class="reference internal" href="#mutex.mutex.lock"><tt class="xref docutils literal"><span class="pre">lock()</span></tt></a>, where a function is called once the lock is acquired.</p>
</dd></dl>
<div class="section" id="mutex-objects">
<span id="id1"></span><h2>9.9.1. Mutex Objects<a class="headerlink" href="#mutex-objects" title="Permalink to this headline">¶</a></h2>
<p><a title="mutex.mutex" class="reference internal" href="#mutex.mutex"><tt class="xref docutils literal"><span class="pre">mutex</span></tt></a> objects have following methods:</p>
<dl class="method">
<dt id="mutex.mutex.test">
<tt class="descclassname">mutex.</tt><tt class="descname">test</tt><big>(</big><big>)</big><a class="headerlink" href="#mutex.mutex.test" title="Permalink to this definition">¶</a></dt>
<dd>Check whether the mutex is locked.</dd></dl>
<dl class="method">
<dt id="mutex.mutex.testandset">
<tt class="descclassname">mutex.</tt><tt class="descname">testandset</tt><big>(</big><big>)</big><a class="headerlink" href="#mutex.mutex.testandset" title="Permalink to this definition">¶</a></dt>
<dd>“Atomic” test-and-set, grab the lock if it is not set, and return <tt class="xref docutils literal"><span class="pre">True</span></tt>,
otherwise, return <tt class="xref docutils literal"><span class="pre">False</span></tt>.</dd></dl>
<dl class="method">
<dt id="mutex.mutex.lock">
<tt class="descclassname">mutex.</tt><tt class="descname">lock</tt><big>(</big><em>function</em>, <em>argument</em><big>)</big><a class="headerlink" href="#mutex.mutex.lock" title="Permalink to this definition">¶</a></dt>
<dd>Execute <tt class="docutils literal"><span class="pre">function(argument)</span></tt>, unless the mutex is locked. In the case it is
locked, place the function and argument on the queue. See <a title="mutex.mutex.unlock" class="reference internal" href="#mutex.mutex.unlock"><tt class="xref docutils literal"><span class="pre">unlock()</span></tt></a> for
explanation of when <tt class="docutils literal"><span class="pre">function(argument)</span></tt> is executed in that case.</dd></dl>
<dl class="method">
<dt id="mutex.mutex.unlock">
<tt class="descclassname">mutex.</tt><tt class="descname">unlock</tt><big>(</big><big>)</big><a class="headerlink" href="#mutex.mutex.unlock" title="Permalink to this definition">¶</a></dt>
<dd>Unlock the mutex if queue is empty, otherwise execute the first element in the
queue.</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">9.9. <tt class="docutils literal"><span class="pre">mutex</span></tt> — Mutual exclusion support</a><ul>
<li><a class="reference external" href="#mutex-objects">9.9.1. Mutex Objects</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="sched.html"
title="previous chapter">9.8. <tt class="docutils literal"><span class="pre">sched</span></tt> — Event scheduler</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="queue.html"
title="next chapter">9.10. <tt class="docutils literal"><span class="pre">queue</span></tt> — A synchronized queue class</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/library/mutex.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="queue.html" title="9.10. queue — A synchronized queue class"
>next</a> |</li>
<li class="right" >
<a href="sched.html" title="9.8. sched — Event scheduler"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="datatypes.html" >9. Data Types</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2010, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Mar 19, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
</div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8f1462e52e1797a02c97073eed0b7f92
>
files
>
819
