<!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>Constructs a new SyncReaderWriter object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.syncreaderwriter.html">SyncReaderWriter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncreaderwriter.readlock.html">SyncReaderWriter::readlock</a></div>
<div class="up"><a href="class.syncreaderwriter.html">SyncReaderWriter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="syncreaderwriter.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">SyncReaderWriter::__construct</h1>
<p class="verinfo">(PECL sync >= 1.0.0)</p><p class="refpurpose"><span class="refname">SyncReaderWriter::__construct</span> — <span class="dc-title">Constructs a new SyncReaderWriter object</span></p>
</div>
<div class="refsect1 description" id="refsect1-syncreaderwriter.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>SyncReaderWriter::__construct</strong></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>
<p class="para rdfs-comment">
Constructs a named or unnamed reader-writer object.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-syncreaderwriter.construct-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">name</code></dt>
<dd>
<p class="para">
The name of the reader-writer if this is a named reader-writer object.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
If the name already exists, it must be able to be opened by the current user
that the process is running as or an exception will be thrown with a meaningless
error message.
</p>
</p></blockquote>
</dd>
<dt>
<code class="parameter">autounlock</code></dt>
<dd>
<p class="para">
Specifies whether or not to automatically unlock the reader-writer at the
conclusion of the PHP script.
</p>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
If an object is: A named reader-writer with an autounlock of FALSE, the
object is locked for either reading or writing, and the PHP script concludes
before the object is unlocked, then the underlying objects will end up in an
inconsistent state.
</p>
</div>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-syncreaderwriter.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The new SyncReaderWriter object. An exception is thrown if the reader-writer
cannot be created or opened.
</p>
</div>
<div class="refsect1 examples" id="refsect1-syncreaderwriter.construct-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4601">
<p><strong>Example #1 <span class="function"><strong>SyncReaderWriter::__construct()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$readwrite </span><span style="color: #007700">= new </span><span style="color: #0000BB">SyncReaderWriter</span><span style="color: #007700">(</span><span style="color: #DD0000">"FileCacheLock"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$readwrite</span><span style="color: #007700">-></span><span style="color: #0000BB">readlock</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">/* ... */<br /></span><span style="color: #0000BB">$readwrite</span><span style="color: #007700">-></span><span style="color: #0000BB">readunlock</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$readwrite</span><span style="color: #007700">-></span><span style="color: #0000BB">writelock</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">/* ... */<br /></span><span style="color: #0000BB">$readwrite</span><span style="color: #007700">-></span><span style="color: #0000BB">writeunlock</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-syncreaderwriter.construct-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="syncreaderwriter.readlock.html" class="methodname" rel="rdfs-seeAlso">SyncReaderWriter::readlock()</a> - Waits for a read lock</span></li>
<li class="member"><span class="methodname"><a href="syncreaderwriter.readunlock.html" class="methodname" rel="rdfs-seeAlso">SyncReaderWriter::readunlock()</a> - Releases a read lock</span></li>
<li class="member"><span class="methodname"><a href="syncreaderwriter.writelock.html" class="methodname" rel="rdfs-seeAlso">SyncReaderWriter::writelock()</a> - Waits for an exclusive write lock</span></li>
<li class="member"><span class="methodname"><a href="syncreaderwriter.writeunlock.html" class="methodname" rel="rdfs-seeAlso">SyncReaderWriter::writeunlock()</a> - Releases a write 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="class.syncreaderwriter.html">SyncReaderWriter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncreaderwriter.readlock.html">SyncReaderWriter::readlock</a></div>
<div class="up"><a href="class.syncreaderwriter.html">SyncReaderWriter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
