construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="syncreaderwriter.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SyncReaderWriter::__construct</refname>
  <refpurpose>Constructs a new SyncReaderWriter object</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>SyncReaderWriter::__construct</methodname>
   <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>autounlock</parameter><initializer>1</initializer></methodparam>
  </methodsynopsis>
  <para>
   Constructs a named or unnamed reader-writer object.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem>
     <para>
      The name of the reader-writer if this is a named reader-writer object.
     </para>
     <note>
      <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.
      </para>
     </note>
     <note>
      <simpara>
       On Windows, <parameter>name</parameter> must not contain backslashes.
      </simpara>
     </note>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>autounlock</parameter></term>
    <listitem>
     <para>
      Specifies whether or not to automatically unlock the reader-writer at the
      conclusion of the PHP script.
     </para>
     <warning>
      <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.
      </para>
     </warning>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The new <classname>SyncReaderWriter</classname> object.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   An exception is thrown if the reader-writer cannot be created or opened.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>SyncReaderWriter::__construct</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$readwrite = new SyncReaderWriter("FileCacheLock");
$readwrite->readlock();
/* ... */
$readwrite->readunlock();

$readwrite->writelock();
/* ... */
$readwrite->writeunlock();
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SyncReaderWriter::readlock</methodname></member>
   <member><methodname>SyncReaderWriter::readunlock</methodname></member>
   <member><methodname>SyncReaderWriter::writelock</methodname></member>
   <member><methodname>SyncReaderWriter::writeunlock</methodname></member>
  </simplelist>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->