mirror of
https://github.com/php/doc-es.git
synced 2026-04-24 07:38:19 +02:00
Philippe DELENTE
81 lines
2.8 KiB
XML
81 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 20216b916ed583938672cd09c2c2f430351430d1 Maintainer: PhilDaiguille Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
|
|
<refentry xml:id="function.com-message-pump" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>com_message_pump</refname>
|
|
<refpurpose>Procesa un mensaje COM en un tiempo dado</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>com_message_pump</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>timeout_milliseconds</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Procesa un mensaje COM esperando hasta <parameter>timeout_milliseconds</parameter>
|
|
milisegundos, o bien esperando a que un mensaje llegue a la cola.
|
|
</para>
|
|
<para>
|
|
El propósito de esta función es enrutar las llamadas COM entre los elementos y gestionar
|
|
las diferentes sincronizaciones. Esto permite que el script espere eficientemente los eventos
|
|
a desencadenar, mientras gestiona otros eventos o ejecuta otros scripts en segundo plano.
|
|
Debe ser utilizada en un bucle, como en el ejemplo de la función
|
|
<function>com_event_sink</function>, hasta que se haya terminado de utilizar los objetos COM relacionados con eventos.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>timeout_milliseconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
El tiempo de espera, en milisegundos.
|
|
</para>
|
|
<para>
|
|
Si no se especifica un valor para el parámetro
|
|
<parameter>timeout_milliseconds</parameter>, entonces será 0.
|
|
Un valor de 0 significa que los mensajes serán procesados inmediatamente;
|
|
si hay mensajes en la cola, serán distribuidos de inmediato;
|
|
si no hay mensajes en la cola, la función devolverá &false;
|
|
inmediatamente sin esperar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Si uno o más mensajes llegan antes de que expire el tiempo de espera,
|
|
serán distribuidos y la función devolverá &true;. Si el tiempo de espera
|
|
expira y no se procesa ningún mensaje, el valor devuelto será &false;.
|
|
</para>
|
|
</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
|
|
-->
|