<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>7.5.2 RLock Objects </title> <META NAME="description" CONTENT="7.5.2 RLock Objects "> <META NAME="keywords" CONTENT="lib"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <meta http-equiv="Content-Type" content="text/html; charset="> <link rel="STYLESHEET" href="lib.css"> <link rel="first" href="lib.html"> <link rel="contents" href="contents.html" title="Contents"> <link rel="index" href="genindex.html" title="Index"> <LINK REL="next" href="condition-objects.html"> <LINK REL="previous" href="lock-objects.html"> <LINK REL="up" href="module-threading.html"> <LINK REL="next" href="condition-objects.html"> </head> <body> <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="lock-objects.html"><img src="../icons/previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="module-threading.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="condition-objects.html"><img src="../icons/next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python Library Reference</td> <td><A href="contents.html"><img src="../icons/contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><a href="modindex.html" title="Module Index"><img src="../icons/modules.gif" border="0" height="32" alt="Module Index" width="32"></a></td> <td><A href="genindex.html"><img src="../icons/index.gif" border="0" height="32" alt="Index" width="32"></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="lock-objects.html">7.5.1 Lock Objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="module-threading.html">7.5 threading </A> <b class="navlabel">Next:</b> <a class="sectref" href="condition-objects.html">7.5.3 Condition Objects</A> <br><hr> </DIV> <!--End of Navigation Panel--> <H2><A NAME="SECTION009520000000000000000"> </A> <BR> 7.5.2 RLock Objects </H2> <P> A reentrant lock is a synchronization primitive that may be acquired multiple times by the same thread. Internally, it uses the concepts of ``owning thread'' and ``recursion level'' in addition to the locked/unlocked state used by primitive locks. In the locked state, some thread owns the lock; in the unlocked state, no thread owns it. <P> To lock the lock, a thread calls its <tt class="method">acquire()</tt> method; this returns once the thread owns the lock. To unlock the lock, a thread calls its <tt class="method">release()</tt> method. <tt class="method">acquire()</tt>/<tt class="method">release()</tt> call pairs may be nested; only the final <tt class="method">release()</tt> (the <tt class="method">release()</tt> of the outermost pair) resets the lock to unlocked and allows another thread blocked in <tt class="method">acquire()</tt> to proceed. <P> <dl><dt><b><a name="l2h-1956"><tt class="method">acquire</tt></a></b>(<big>[</big><var>blocking<code> = 1</code></var><big>]</big>) <dd> Acquire a lock, blocking or non-blocking. <P> When invoked without arguments: if this thread already owns the lock, increment the recursion level by one, and return immediately. Otherwise, if another thread owns the lock, block until the lock is unlocked. Once the lock is unlocked (not owned by any thread), then grab ownership, set the recursion level to one, and return. If more than one thread is blocked waiting until the lock is unlocked, only one at a time will be able to grab ownership of the lock. There is no return value in this case. <P> When invoked with the <var>blocking</var> argument set to true, do the same thing as when called without arguments, and return true. <P> When invoked with the <var>blocking</var> argument set to false, do not block. If a call without an argument would block, return false immediately; otherwise, do the same thing as when called without arguments, and return true. </dl> <P> <dl><dt><b><a name="l2h-1957"><tt class="method">release</tt></a></b>() <dd> Release a lock, decrementing the recursion level. If after the decrement it is zero, reset the lock to unlocked (not owned by any thread), and if any other threads are blocked waiting for the lock to become unlocked, allow exactly one of them to proceed. If after the decrement the recursion level is still nonzero, the lock remains locked and owned by the calling thread. <P> Only call this method when the calling thread owns the lock. Do not call this method when the lock is unlocked. <P> There is no return value. </dl> <P> <DIV CLASS="navigation"> <p><hr> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="lock-objects.html"><img src="../icons/previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="module-threading.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="condition-objects.html"><img src="../icons/next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Python Library Reference</td> <td><A href="contents.html"><img src="../icons/contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><a href="modindex.html" title="Module Index"><img src="../icons/modules.gif" border="0" height="32" alt="Module Index" width="32"></a></td> <td><A href="genindex.html"><img src="../icons/index.gif" border="0" height="32" alt="Index" width="32"></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="lock-objects.html">7.5.1 Lock Objects</A> <b class="navlabel">Up:</b> <a class="sectref" href="module-threading.html">7.5 threading </A> <b class="navlabel">Next:</b> <a class="sectref" href="condition-objects.html">7.5.3 Condition Objects</A> <hr> <span class="release-info">Release 2.2, documentation updated on December 21, 2001.</span> </DIV> <!--End of Navigation Panel--> <ADDRESS> See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. </ADDRESS> </BODY> </HTML>
