construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsharedmemory.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SyncSharedMemory::__construct</refname>
  <refpurpose>Construye un nuevo objeto SyncSharedMemory</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>SyncSharedMemory::__construct</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
  </methodsynopsis>
  <para>
   Construye un objeto de memoria compartida con nombre.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem>
     <para>
      El nombre del objeto de memoria compartida.
     </para>
     <note>
      <para>
       Si el nombre ya existe, debe poder ser abierto por el usuario actual
       que el proceso está en ejecución o se lanzará una excepción con un mensaje de error
       sin significado.
      </para>
     </note>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>size</parameter></term>
    <listitem>
     <para>
      El tamaño, en bytes, de la memoria compartida a reservar.
     </para>
     <note>
      <para>
       La cantidad de memoria no puede ser redimensionada posteriormente. Solicite suficiente almacenamiento de antemano.
      </para>
     </note>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

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

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

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo de <function>SyncSharedMemory::__construct</function></title>
   <programlisting role="php">
<![CDATA[
<?php
// Probablemente se deberá proteger la memoria compartida con otros objetos de sincronización.
// La memoria compartida desaparece cuando la última referencia a ella desaparece.
$mem = new SyncSharedMemory("AppReportName", 1024);
if ($mem->first())
{
    // Realizar el trabajo de inicialización la primera vez aquí.
}

$result = $mem->write(json_encode(array("name" => "my_report.txt")));
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SyncSharedMemory::first</methodname></member>
   <member><methodname>SyncSharedMemory::size</methodname></member>
   <member><methodname>SyncSharedMemory::write</methodname></member>
   <member><methodname>SyncSharedMemory::read</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
-->