<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Unlocks the mutex</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="syncmutex.lock.html">SyncMutex::lock</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.syncsemaphore.html">SyncSemaphore</a></div> <div class="up"><a href="class.syncmutex.html">SyncMutex</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="syncmutex.unlock" class="refentry"> <div class="refnamediv"> <h1 class="refname">SyncMutex::unlock</h1> <p class="verinfo">(PECL sync >= 1.0.0)</p><p class="refpurpose"><span class="refname">SyncMutex::unlock</span> — <span class="dc-title">Unlocks the mutex</span></p> </div> <div class="refsect1 description" id="refsect1-syncmutex.unlock-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SyncMutex::unlock</strong></span> ([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$all</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span> ] )</div> <p class="para rdfs-comment"> Decreases the internal counter of a SyncMutex object. When the internal counter reaches zero, the actual lock on the object is released. </p> </div> <div class="refsect1 parameters" id="refsect1-syncmutex.unlock-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">all</code></dt> <dd> <p class="para"> Specifies whether or not to set the internal counter to zero and therefore release the lock. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-syncmutex.unlock-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> A boolean of TRUE if the unlock operation was successful, FALSE otherwise. </p> </div> <div class="refsect1 examples" id="refsect1-syncmutex.unlock-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-4593"> <p><strong>Example #1 <span class="function"><strong>SyncMutex::unlock()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$mutex </span><span style="color: #007700">= new </span><span style="color: #0000BB">SyncMutex</span><span style="color: #007700">(</span><span style="color: #DD0000">"UniqueName"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$mutex</span><span style="color: #007700">-></span><span style="color: #0000BB">lock</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* ... */<br /><br /></span><span style="color: #0000BB">$mutex</span><span style="color: #007700">-></span><span style="color: #0000BB">unlock</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-syncmutex.unlock-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="methodname"><a href="syncmutex.lock.html" class="methodname" rel="rdfs-seeAlso">SyncMutex::lock()</a> - Waits for an exclusive lock</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="syncmutex.lock.html">SyncMutex::lock</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.syncsemaphore.html">SyncSemaphore</a></div> <div class="up"><a href="class.syncmutex.html">SyncMutex</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>