<!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>The SyncMutex class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sync.constants.html">Predefined Constants</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncmutex.construct.html">SyncMutex::__construct</a></div>
<div class="up"><a href="book.sync.html">Sync</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.syncmutex" class="reference">
<h1 class="title">The SyncMutex class</h1>
<div class="partintro"><p class="verinfo">(PECL sync >= 1.0.0)</p>
<div class="section" id="syncmutex.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A cross-platform, native implementation of named and unnamed countable mutex objects.
</p>
<p class="para">
A mutex is a mutual exclusion object that restricts access to a shared resource (e.g. a file) to a single instance.
Countable mutexes acquire the mutex a single time and internally track the number of times the mutex is locked.
The mutex is unlocked as soon as it goes out of scope or is unlocked the same number of times that it was locked.
</p>
</div>
<div class="section" id="syncmutex.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SyncMutex</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="syncmutex.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="syncmutex.lock.html" class="methodname">lock</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$wait</code><span class="initializer"> = -1</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="syncmutex.unlock.html" class="methodname">unlock</a></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>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="syncmutex.construct.html">SyncMutex::__construct</a> — Constructs a new SyncMutex object</li><li><a href="syncmutex.lock.html">SyncMutex::lock</a> — Waits for an exclusive lock</li><li><a href="syncmutex.unlock.html">SyncMutex::unlock</a> — Unlocks the mutex</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sync.constants.html">Predefined Constants</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncmutex.construct.html">SyncMutex::__construct</a></div>
<div class="up"><a href="book.sync.html">Sync</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
