construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f12b4010435efc7a015e65fbd274740710368487 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<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>Construye un nuevo objeto SyncReaderWriter</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>
   Construye un objeto de lectura/escritura nombrado o no.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem>
     <para>
      El nombre del objeto si está nombrado.
     </para>
     <note>
      <para>
       Si el nombre ya existe, el objeto debe poder ser abierto con el usuario
       actual que ejecuta el proceso, o se emitirá una excepción conteniendo
       el mensaje de error.
      </para>
     </note>
     <note>
      <simpara>
       En Windows, <parameter>name</parameter> no debe contener barras invertidas.
      </simpara>
     </note>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>autounlock</parameter></term>
    <listitem>
     <para>
      Especifica si se debe desbloquear automáticamente el objeto al final del
      script PHP.
     </para>
     <warning>
      <para>
       Si el objeto es un objeto de lectura/escritura con el autounlock en &false;,
       el objeto está bloqueado en lectura o en escritura, y el script PHP
       terminará antes del desbloqueo del objeto, y por lo tanto, el objeto
       subyacente terminará en un estado no consistente.
      </para>
     </warning>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   El nuevo objeto <classname>SyncReaderWriter</classname>.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Se emite una excepción si el objeto de
   lectura/escritura no puede ser creado o abierto.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo con <function>SyncReaderWriter::__construct</function></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
-->