<!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 SyncReaderWriter class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="syncevent.wait.html">SyncEvent::wait</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncreaderwriter.construct.html">SyncReaderWriter::__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.syncreaderwriter" class="reference">
<h1 class="title">The SyncReaderWriter class</h1>
<div class="partintro"><p class="verinfo">(PECL sync >= 1.0.0)</p>
<div class="section" id="syncreaderwriter.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A cross-platform, native implementation of named and unnamed reader-writer objects.
</p>
<p class="para">
A reader-writer object allows many readers or one writer to access a resource.
This is an efficient solution for managing resources where access will primarily be
read-only but exclusive write access is occasionally necessary.
</p>
</div>
<div class="section" id="syncreaderwriter.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SyncReaderWriter</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="syncreaderwriter.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$autounlock</code><span class="initializer"> = <strong><code>TRUE</code></strong></span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="syncreaderwriter.readlock.html" class="methodname">readlock</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="syncreaderwriter.readunlock.html" class="methodname">readunlock</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="syncreaderwriter.writelock.html" class="methodname">writelock</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="syncreaderwriter.writeunlock.html" class="methodname">writeunlock</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="syncreaderwriter.construct.html">SyncReaderWriter::__construct</a> — Constructs a new SyncReaderWriter object</li><li><a href="syncreaderwriter.readlock.html">SyncReaderWriter::readlock</a> — Waits for a read lock</li><li><a href="syncreaderwriter.readunlock.html">SyncReaderWriter::readunlock</a> — Releases a read lock</li><li><a href="syncreaderwriter.writelock.html">SyncReaderWriter::writelock</a> — Waits for an exclusive write lock</li><li><a href="syncreaderwriter.writeunlock.html">SyncReaderWriter::writeunlock</a> — Releases a write lock</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="syncevent.wait.html">SyncEvent::wait</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncreaderwriter.construct.html">SyncReaderWriter::__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>
