1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-23 23:12:09 +01:00

sync : fix XML by converting para to simpara tags via script

This commit is contained in:
Gina Peter Banyard
2026-01-25 15:11:36 +00:00
parent 70ec25ead9
commit 8729c74c43
28 changed files with 268 additions and 315 deletions

View File

@@ -1,41 +1,40 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4110331afec1fc2bfe27525341a5f96e0804692f Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<book xml:id="book.sync" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.sync">
<?phpdoc extension-membership="pecl" ?>
<title>Sync</title>
<titleabbrev>Sync</titleabbrev>
<preface xml:id="intro.sync">
&reftitle.intro;
<para>
<simpara>
La extensión <literal>sync</literal> introduce la sincronización de objetos cross-plataforma en PHP.
Los Mutex nombrados o no, los semáforos, los eventos, los objetos de
lectura-escritura y la memoria compartida se beneficiarán de una sincronización a nivel del sistema operativo tanto en
los sistemas POSIX (i.e. Linux) como en los sistemas Windows.
</para>
<para>
</simpara>
<simpara>
Una limpieza automática de los objetos que han obtenido una sincronización
se realiza al desmontar la extensión. Esto significa que si PHP termina prematuramente
un script (i.e. el script excede su tiempo máximo de ejecución), los objetos
no se dejarán en un estado desconocido. La única excepción a este mecanismo
es si PHP mismo se bloquea (i.e. un desbordamiento de buffer interno).
</para>
<para>
</simpara>
<simpara>
La sincronización de los objetos no nombrados no tiene utilidad fuera de un
escenario multihilo. Los objetos no nombrados son más útiles en conjunción
con la extensión PECL pthreads.
</para>
</simpara>
<note>
<para>
<simpara>
Los objetos nombrados requieren atención adicional para ser utilizados
en todos los sistemas. Si un objeto se instancia con un conjunto específico de
parámetros, siempre debe ser instanciado con estos parámetros o el objeto
probablemente terminará en un estado no consistente hasta el próximo
reinicio o hasta que un administrador los limpie.
</para>
</simpara>
</note>
</preface>
@@ -47,7 +46,6 @@
&reference.sync.syncsharedmemory;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,18 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8690c4193b8d86dc5494de23db1f80d53ce37adc Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<section xml:id="sync.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sync.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;sync">&url.pecl.package;sync</link>
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,28 +1,26 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 48ce43fe79fa0c9f31f187ea8ec995b4cb13037e Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<chapter xml:id="sync.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sync.setup">
&reftitle.setup;
<section xml:id="sync.requirements">
&reftitle.required;
<para>
<simpara>
Un sistema con soporte POSIX de memoria compartida (shm_open()) o funcionando bajo Windows.
</para>
</simpara>
</section>
<section xml:id="sync.installation">
&reftitle.install;
<para>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;sync">&url.pecl.package;sync</link>.
</para>
</simpara>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8690c4193b8d86dc5494de23db1f80d53ce37adc Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<reference xml:id="class.syncevent" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.syncevent" role="class">
<title>La clase SyncEvent</title>
<titleabbrev>SyncEvent</titleabbrev>
@@ -13,15 +12,15 @@
<!-- {{{ SyncEvent intro -->
<section xml:id="syncevent.intro">
&reftitle.intro;
<para>
<simpara>
Una implementación multiplataforma nativa de objetos de eventos nombrados o sin nombre.
Se soportan tanto los objetos de eventos automáticos como manuales.
</para>
<para>
</simpara>
<simpara>
Un objeto de evento espera, sin cola, que los objetos sean lanzados/definidos.
Una instancia espera en el objeto de evento mientras otra lanza/define el evento.
Los objetos de eventos son útiles a lo largo de un proceso largo (i.e. verificar si una descarga de datos debe ser analizada).
</para>
</simpara>
</section>
<!-- }}} -->
@@ -41,7 +40,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncevent')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncevent')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -52,7 +51,6 @@
&reference.sync.entities.syncevent;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0aba4b20cc0b96b2c7672d246a7d93ea2fff8335 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncevent.construct">
<refnamediv>
@@ -16,9 +16,9 @@
<methodparam choice="opt"><type>bool</type><parameter>manual</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>prefire</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Construye un objeto de evento nombrado o no.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,44 +27,44 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
El nombre del evento si es un objeto de evento nombrado.
</para>
</simpara>
<note>
<para>
<simpara>
Si el nombre ya existe, debe ser posible abrirlo con el usuario
actual que ejecuta el proceso, o se lanzará una excepción
con el contenido del mensaje de error.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>manual</parameter></term>
<listitem>
<para>
<simpara>
Especifica si el objeto de evento debe ser reinicializado manualmente o no.
</para>
</simpara>
<note>
<para>
<simpara>
La reinicialización manual de los objetos de eventos permite la
puesta en espera de los procesos hasta que el objeto sea reinicializado.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>prefire</parameter></term>
<listitem>
<para>
<simpara>
Especifica si se debe o no pre-enviar (la señal)
al objeto de evento.
</para>
</simpara>
<note>
<para>
<simpara>
Solo tiene impacto si la llamada al proceso/hilo
es el primero en crear el objeto.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -73,17 +73,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
El nuevo objeto <classname>SyncEvent</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
Se lanza una excepción si el objeto de evento
no puede ser creado o abierto.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -120,9 +120,9 @@ $event->wait();
<row>
<entry>PECL sync 1.1.0</entry>
<entry>
<para>
<simpara>
Adición del parámetro <parameter>prefire</parameter>.
</para>
</simpara>
</entry>
</row>
</tbody>

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncevent.fire" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncevent.fire">
<refnamediv>
<refname>SyncEvent::fire</refname>
<refpurpose>Lanza/define el evento</refpurpose>
@@ -13,12 +12,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SyncEvent::fire</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Lanza/define un objeto <classname>SyncEvent</classname>. Mantiene varios hilos en espera
si el objeto de evento ha sido creado con un valor manual a &true;.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -62,7 +61,6 @@ $event->wait();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncevent.reset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncevent.reset">
<refnamediv>
<refname>SyncEvent::reset</refname>
<refpurpose>Reinicializa manualmente un evento</refpurpose>
@@ -13,12 +12,12 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SyncEvent::reset</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Reinicializa un objeto <classname>SyncEvent</classname> que ha sido lanzado/definido. Solo válido para
los objetos de evento manuales.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,9 +27,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -65,7 +64,6 @@ $event->fire();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncevent.wait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncevent.wait">
<refnamediv>
<refname>SyncEvent::wait</refname>
<refpurpose>Espera a que el objeto SyncEvent sea lanzado</refpurpose>
@@ -15,9 +14,9 @@
<modifier>public</modifier> <type>bool</type><methodname>SyncEvent::wait</methodname>
<methodparam choice="opt"><type>int</type><parameter>wait</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Espera a que el objeto <classname>SyncEvent</classname> sea lanzado.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,10 +25,10 @@
<varlistentry>
<term><parameter>wait</parameter></term>
<listitem>
<para>
<simpara>
El número de milisegundos a esperar a que el evento sea lanzado.
Un valor de -1 significa que se espera indefinidamente.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -70,7 +69,6 @@ $event->wait();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8690c4193b8d86dc5494de23db1f80d53ce37adc Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<reference xml:id="class.syncmutex" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.syncmutex" role="class">
<title>La clase SyncMutex</title>
<titleabbrev>SyncMutex</titleabbrev>
@@ -13,16 +12,16 @@
<!-- {{{ SyncMutex intro -->
<section xml:id="syncmutex.intro">
&reftitle.intro;
<para>
<simpara>
Una implementación multiplataforma, nativa de los objetos Mutex nombrados o no nombrados.
</para>
<para>
</simpara>
<simpara>
Un Mutex es un objeto de exclusión mutua que restringe el acceso a un recurso compartido
(i.e. un fichero) a una sola instancia. Los Mutex contables adquieren el mutex una
sola vez y, internamente, rastrean el número de veces que el mutex es bloqueado.
El Mutex es desbloqueado tan pronto como sale del ámbito o es desbloqueado el
mismo número de veces que ha sido bloqueado.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -42,7 +41,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncmutex')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncmutex')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -53,7 +52,6 @@
&reference.sync.entities.syncmutex;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncmutex.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncmutex.construct">
<refnamediv>
<refname>SyncMutex::__construct</refname>
<refpurpose>Construye un nuevo objeto SyncMutex</refpurpose>
@@ -15,9 +14,9 @@
<modifier>public</modifier> <methodname>SyncMutex::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Construye un objeto contable nombrado o no.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,15 +25,15 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
El nombre del mutex si se trata de un objeto mutex nombrado.
</para>
</simpara>
<note>
<para>
<simpara>
Si el nombre ya existe, debe ser capaz de ser abierto por el usuario
actual ejecutando el proceso, o bien se lanzará una excepción
con el mensaje de error correspondiente.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -43,17 +42,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
El nuevo objeto <classname>SyncMutex</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
Se lanza una excepción si el mutex no puede
ser creado o abierto.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -108,7 +107,6 @@ $mutex->unlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncmutex.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncmutex.lock">
<refnamediv>
<refname>SyncMutex::lock</refname>
<refpurpose>Obtiene un bloqueo exclusivo</refpurpose>
@@ -15,10 +14,10 @@
<modifier>public</modifier> <type>bool</type><methodname>SyncMutex::lock</methodname>
<methodparam choice="opt"><type>int</type><parameter>wait</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Obtiene un bloqueo exclusivo sobre un objeto <classname>SyncMutex</classname>.
Si el bloqueo ya está adquirido, entonces este método incrementará el contador interno.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,10 +26,10 @@
<varlistentry>
<term><parameter>wait</parameter></term>
<listitem>
<para>
<simpara>
El número de milisegundos a esperar para la obtención del bloqueo exclusivo.
Un valor de -1 significa que se espera indefinidamente.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -76,7 +75,6 @@ $mutex->unlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncmutex.unlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncmutex.unlock">
<refnamediv>
<refname>SyncMutex::unlock</refname>
<refpurpose>Desbloquea el mutex</refpurpose>
@@ -15,11 +14,11 @@
<modifier>public</modifier> <type>bool</type><methodname>SyncMutex::unlock</methodname>
<methodparam choice="opt"><type>bool</type><parameter>all</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Decrementa el contador interno de un objeto <classname>SyncMutex</classname>.
Cuando el contador interno llega a cero, el bloqueo actual
del objeto se libera.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,10 +27,10 @@
<varlistentry>
<term><parameter>all</parameter></term>
<listitem>
<para>
<simpara>
Especifica si se debe o no establecer el contador interno a cero
y, por lo tanto, liberar el bloqueo.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -72,7 +71,6 @@ $mutex->unlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8690c4193b8d86dc5494de23db1f80d53ce37adc Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<reference xml:id="class.syncreaderwriter" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.syncreaderwriter" role="class">
<title>La clase SyncReaderWriter</title>
<titleabbrev>SyncReaderWriter</titleabbrev>
@@ -13,12 +12,12 @@
<!-- {{{ SyncReaderWriter intro -->
<section xml:id="syncreaderwriter.intro">
&reftitle.intro;
<para>
<simpara>
Una implementación multiplataforma, nativa de los objetos de lectura-escritura nombrados o no.
</para>
<para>
</simpara>
<simpara>
Un objeto de lectura-escritura permite múltiples lecturas o una escritura para acceder a un recurso. Es una solución eficiente para gestionar los recursos donde el acceso es originalmente de solo lectura, pero un acceso de escritura es ocasionalmente necesario.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -38,7 +37,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncreaderwriter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncreaderwriter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -49,7 +48,6 @@
&reference.sync.entities.syncreaderwriter;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f12b4010435efc7a015e65fbd274740710368487 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 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">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncreaderwriter.construct">
<refnamediv>
<refname>SyncReaderWriter::__construct</refname>
<refpurpose>Construye un nuevo objeto SyncReaderWriter</refpurpose>
@@ -15,9 +15,9 @@
<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>
<simpara>
Construye un objeto de lectura/escritura nombrado o no.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,15 +26,15 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
El nombre del objeto si está nombrado.
</para>
</simpara>
<note>
<para>
<simpara>
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>
</simpara>
</note>
<note>
<simpara>
@@ -46,17 +46,17 @@
<varlistentry>
<term><parameter>autounlock</parameter></term>
<listitem>
<para>
<simpara>
Especifica si se debe desbloquear automáticamente el objeto al final del
script PHP.
</para>
</simpara>
<warning>
<para>
<simpara>
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>
</simpara>
</warning>
</listitem>
</varlistentry>
@@ -65,17 +65,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
El nuevo objeto <classname>SyncReaderWriter</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
Se emite una excepción si el objeto de
lectura/escritura no puede ser creado o abierto.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -110,7 +110,6 @@ $readwrite->writeunlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncreaderwriter.readlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncreaderwriter.readlock">
<refnamediv>
<refname>SyncReaderWriter::readlock</refname>
<refpurpose>Obtiene un bloqueo de lectura</refpurpose>
@@ -15,9 +14,9 @@
<modifier>public</modifier> <type>bool</type><methodname>SyncReaderWriter::readlock</methodname>
<methodparam choice="opt"><type>int</type><parameter>wait</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Obtiene un bloqueo de lectura en un objeto <classname>SyncReaderWriter</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,10 +25,10 @@
<varlistentry>
<term><parameter>wait</parameter></term>
<listitem>
<para>
<simpara>
El número de milisegundos de espera para obtener un bloqueo. Un valor de -1 significa
que se espera indefinidamente.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -67,7 +66,6 @@ $readwrite->readunlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncreaderwriter.readunlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncreaderwriter.readunlock">
<refnamediv>
<refname>SyncReaderWriter::readunlock</refname>
<refpurpose>Libera un bloqueo de lectura</refpurpose>
@@ -13,11 +12,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SyncReaderWriter::readunlock</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Libera un bloqueo de lectura sobre un objeto <classname>SyncReaderWriter</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -57,7 +56,6 @@ $readwrite->readunlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncreaderwriter.writelock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncreaderwriter.writelock">
<refnamediv>
<refname>SyncReaderWriter::writelock</refname>
<refpurpose>Espera un bloqueo de escritura exclusivo</refpurpose>
@@ -15,9 +14,9 @@
<modifier>public</modifier> <type>bool</type><methodname>SyncReaderWriter::writelock</methodname>
<methodparam choice="opt"><type>int</type><parameter>wait</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Obtiene un bloqueo de escritura exclusivo sobre un objeto <classname>SyncReaderWriter</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,10 +25,10 @@
<varlistentry>
<term><parameter>wait</parameter></term>
<listitem>
<para>
<simpara>
El número de milisegundos para esperar el bloqueo.
Un valor de -1 significa que se espera indefinidamente.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -67,7 +66,6 @@ $readwrite->writeunlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncreaderwriter.writeunlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncreaderwriter.writeunlock">
<refnamediv>
<refname>SyncReaderWriter::writeunlock</refname>
<refpurpose>Libera un bloqueo de escritura</refpurpose>
@@ -13,11 +12,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SyncReaderWriter::writeunlock</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Libera un bloqueo de escritura en un objeto <classname>SyncReaderWriter</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -57,7 +56,6 @@ $readwrite->writeunlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5a06a49d4530e1ac9b3d46e652d5ef5fa0b4cade Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<reference xml:id="class.syncsemaphore" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.syncsemaphore" role="class">
<title>La clase SyncSemaphore</title>
<titleabbrev>SyncSemaphore</titleabbrev>
@@ -13,15 +12,15 @@
<!-- {{{ SyncSemaphore intro -->
<section xml:id="syncsemaphore.intro">
&reftitle.intro;
<para>
<simpara>
Una implementación multiplataforma, nativa de los objetos Sémaphore nombrados o no nombrados.
</para>
<para>
</simpara>
<simpara>
Un sémaphore restringe el acceso a un recurso limitado a un número limitado
de instancias. Los sémaphores difieren de los mutexes en el sentido de que permiten
a más de una instancia acceder a un recurso al mismo tiempo, mientras que el mutex
solo permite una instancia a la vez.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -41,7 +40,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncsemaphore')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncsemaphore')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -52,7 +51,6 @@
&reference.sync.entities.syncsemaphore;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsemaphore.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsemaphore.construct">
<refnamediv>
<refname>SyncSemaphore::__construct</refname>
<refpurpose>Construye un nuevo objeto SyncSemaphore</refpurpose>
@@ -17,9 +16,9 @@
<methodparam choice="opt"><type>int</type><parameter>initialval</parameter><initializer>1</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>autounlock</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Construye un semáforo con nombre o sin nombre.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,36 +27,36 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
El nombre del semáforo si tiene nombre.
</para>
</simpara>
<note>
<para>
<simpara>
Si el nombre ya existe, el objeto debe poder ser abierto por el usuario
actual que ejecuta el proceso, o se emitirá una excepción con el mensaje de error.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>initialval</parameter></term>
<listitem>
<para>
<simpara>
El valor inicial del semáforo. Este será el número de bloqueos que pueden
ser obtenidos.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>autounlock</parameter></term>
<listitem>
<para>
<simpara>
Especifica si se debe desbloquear automáticamente el semáforo al final del script PHP.
</para>
</simpara>
<warning>
<para>
<simpara>
Si el objeto es un semáforo con nombre cuyo autounlock es &false;, el objeto está bloqueado, y el script PHP termina antes de que el objeto sea desbloqueado, entonces el semáforo subyacente terminará en un estado no consistente.
</para>
</simpara>
</warning>
</listitem>
</varlistentry>
@@ -66,16 +65,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
El nuevo objeto <classname>SyncSemaphore</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
Se emitirá una excepción si el semáforo no puede ser creado o abierto.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -112,7 +111,6 @@ $semaphore->unlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsemaphore.lock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsemaphore.lock">
<refnamediv>
<refname>SyncSemaphore::lock</refname>
<refpurpose>Disminuye el contador del objeto SyncSemaphore o espera</refpurpose>
@@ -15,10 +14,10 @@
<modifier>public</modifier> <type>bool</type><methodname>SyncSemaphore::lock</methodname>
<methodparam choice="opt"><type>int</type><parameter>wait</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Disminuye el contador del objeto <classname>SyncSemaphore</classname> o espera hasta que el semáforo
tenga un valor diferente de cero.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,10 +26,10 @@
<varlistentry>
<term><parameter>wait</parameter></term>
<listitem>
<para>
<simpara>
El número de milisegundos a esperar por el semáforo.
Un valor de -1 significa que se espera indefinidamente.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -76,7 +75,6 @@ $semaphore->unlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,9 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsemaphore.unlock" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsemaphore.unlock">
<refnamediv>
<refname>SyncSemaphore::unlock</refname>
<refpurpose>Incrementa el contador del objeto SyncSemaphore</refpurpose>
@@ -15,9 +14,9 @@
<modifier>public</modifier> <type>bool</type><methodname>SyncSemaphore::unlock</methodname>
<methodparam choice="opt"><type>int</type><parameter role="reference">prevcount</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Incrementa el contador del objeto <classname>SyncSemaphore</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +25,9 @@
<varlistentry>
<term><parameter>prevcount</parameter></term>
<listitem>
<para>
<simpara>
Devuelve el contador anterior del semáforo.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -74,7 +73,6 @@ $semaphore->unlock();
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4d17b7b4947e7819ff5036715dd706be87ae4def Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<reference xml:id="class.syncsharedmemory" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.syncsharedmemory" role="class">
<title>La clase SyncSharedMemory</title>
<titleabbrev>SyncSharedMemory</titleabbrev>
@@ -10,18 +10,18 @@
<!-- {{{ SyncSharedMemory intro -->
<section xml:id="syncsharedmemory.intro">
&reftitle.intro;
<para>
<simpara>
Una implementación nativa, coherente y multiplataforma de objetos de memoria compartida nombrada.
</para>
<para>
</simpara>
<simpara>
La memoria compartida permite a dos procesos distintos comunicarse sin necesidad de
tuberías o sockets complejos. Existen varias implementaciones de memoria compartida
basadas en enteros para PHP. La memoria compartida nombrada es una alternativa.
</para>
<para>
</simpara>
<simpara>
Los objetos de sincronización (por ejemplo, SyncMutex) son siempre necesarios para proteger la mayoría
de los usos de la memoria compartida.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -41,7 +41,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncsharedmemory')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.syncsharedmemory')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -52,7 +52,6 @@
&reference.sync.entities.syncsharedmemory;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 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">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsharedmemory.construct">
<refnamediv>
<refname>SyncSharedMemory::__construct</refname>
<refpurpose>Construye un nuevo objeto SyncSharedMemory</refpurpose>
@@ -14,9 +14,9 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Construye un objeto de memoria compartida con nombre.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,28 +25,28 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
<simpara>
El nombre del objeto de memoria compartida.
</para>
</simpara>
<note>
<para>
<simpara>
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>
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
<simpara>
El tamaño, en bytes, de la memoria compartida a reservar.
</para>
</simpara>
<note>
<para>
<simpara>
La cantidad de memoria no puede ser redimensionada posteriormente. Solicite suficiente almacenamiento de antemano.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -55,16 +55,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
El nuevo objeto <classname>SyncSharedMemory</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
Se lanza una excepción si el objeto de memoria compartida no puede ser creado o abierto.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -100,7 +100,6 @@ $result = $mem->write(json_encode(array("name" => "my_report.txt")));
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsharedmemory.first" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsharedmemory.first">
<refnamediv>
<refname>SyncSharedMemory::first</refname>
<refpurpose>Verifica si el objeto es la primera instancia en todo el sistema de la memoria compartida nombrada</refpurpose>
@@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SyncSharedMemory::first</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Recupera el estado de primera instancia del objeto <classname>SyncSharedMemory</classname> en todo el sistema.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -70,7 +70,6 @@ bool(false)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: be295015d068095fc92880baef4e47038646adbd Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsharedmemory.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsharedmemory.read">
<refnamediv>
<refname>SyncSharedMemory::read</refname>
<refpurpose>Copia de datos de la memoria compartida nombrada</refpurpose>
@@ -14,9 +14,9 @@
<methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Copia de datos de la memoria compartida nombrada.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,31 +25,31 @@
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<para>
<simpara>
El inicio/desplazamiento, en bytes, para comenzar la lectura.
</para>
</simpara>
<note>
<para>
<simpara>
Si el valor es negativo, la posición de inicio comenzará en el número especificado
de bytes desde el final del segmento de memoria compartida.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<simpara>
El número de bytes a leer.
</para>
</simpara>
<note>
<para>
<simpara>
Si no se especifica, la lectura se detendrá al final del segmento de memoria compartida.
</para>
<para>
</simpara>
<simpara>
Si el valor es negativo, la lectura se detendrá en el número especificado de bytes
desde el final del segmento de memoria compartida.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -58,9 +58,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Un string que contiene los datos leídos de la memoria compartida.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -105,7 +105,6 @@ string(3) "ort"
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 424ecfb1e31adff4e8159fdfa545cedfb713575d Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsharedmemory.size" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsharedmemory.size">
<refnamediv>
<refname>SyncSharedMemory::size</refname>
<refpurpose>Devuelve el tamaño de la memoria compartida nombrada</refpurpose>
@@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>SyncSharedMemory::size</methodname>
<void />
<void/>
</methodsynopsis>
<para>
<simpara>
Recupera el tamaño de la memoria compartida de un objeto <classname>SyncSharedMemory</classname>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Un integer que contiene el tamaño de la memoria compartida. Este será el mismo tamaño que se pasó al constructor.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -61,7 +61,6 @@ int(1024)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0da76b0197f60f498c56cc7a57c243b3865ce6b7 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: f0edac3006cc81cc9cd06fd21d4f4bdc244e10c9 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yew Maintainer: Marqitos -->
<refentry xml:id="syncsharedmemory.write" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="syncsharedmemory.write">
<refnamediv>
<refname>SyncSharedMemory::write</refname>
<refpurpose>Copia los datos en la memoria compartida nombrada</refpurpose>
@@ -14,9 +14,9 @@
<methodparam choice="opt"><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Copia los datos en la memoria compartida nombrada.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,28 +25,28 @@
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
<simpara>
Los datos a escribir en la memoria compartida.
</para>
</simpara>
<note>
<para>
<simpara>
Si el tamaño de los datos excede el tamaño de la memoria compartida, el número
de bytes escritos devueltos será inferior a la longitud de la entrada.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<para>
<simpara>
El inicio/desplazamiento, en bytes, para comenzar la escritura.
</para>
</simpara>
<note>
<para>
<simpara>
Si el valor es negativo, la posición de inicio comenzará en el número especificado
de bytes desde el final del segmento de memoria compartida.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
@@ -55,9 +55,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Un integer que contiene el número de bytes escritos en la memoria compartida.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -104,7 +104,6 @@ int(3)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml