mirror of
https://github.com/php/doc-ru.git
synced 2026-03-26 00:32:15 +01:00
79 lines
3.4 KiB
XML
79 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- EN-Revision: 20216b916ed583938672cd09c2c2f430351430d1 Maintainer: rjhdby Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
<refentry xml:id="function.com-message-pump" xmlns="http://docbook.org/ns/docbook">
|
||
<refnamediv>
|
||
<refname>com_message_pump</refname>
|
||
<refpurpose>Обработка сообщений COM, пришедших не позднее timeoutms миллисекунд после её запуска</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>
|
||
Функция "засыпает" на <parameter>timeout_milliseconds</parameter> миллисекунд, либо
|
||
пока в очередь не придёт новое сообщение.
|
||
</para>
|
||
<para>
|
||
Назначение функции состоит в маршрутизации вызовов COM между
|
||
подразделениями и обработке различных асинхронных задач.
|
||
Она позволит вашему скрипту ожидать возникновения события, одновременно
|
||
с этим перехватывая другие события или выполняя другой код в фоне. Вы должны
|
||
использовать её в цикле, как показано в примере функции
|
||
<function>com_event_sink</function> до момента прекращения использования привязки
|
||
событий объекта COM.
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>timeout_milliseconds</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Задержка в миллисекундах.
|
||
</para>
|
||
<para>
|
||
Если значение <parameter>timeout_milliseconds</parameter> не задано, то оно будет
|
||
считаться равным нулю. Это означает, что задержки не будет. Если при этом
|
||
присутствует ожидающее событие, то оно будет обработано как обычно. Если
|
||
события нет, то функция сразу же вернёт &false;.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
Если сообщения пришли до исчерпания задержки, то они будут обработаны
|
||
и функция вернёт &true;. Если время задержки вышло и ни одного сообщения не пришло,
|
||
то функция вернёт &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
|
||
-->
|