ssh2-poll.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 37323ead9517a89b21bd17913c4fa04a9d713f16 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.ssh2-poll" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ssh2_poll</refname>
  <refpurpose>Опрашивает каналы/слушателей/потоки на предмет событий</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>ssh2_poll</methodname>
   <methodparam><type>array</type><parameter role="reference">desc</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>30</initializer></methodparam>
  </methodsynopsis>
  <para>
   Опрашивает каналы/слушателей/потоки на предмет событий
   и возвращает количество дескрипторов, которые вернули ненулевые повторения.
  </para>

  &warn.undocumented.func;

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>desc</parameter></term>
    <listitem>
     <para>
      Индексированный массив подмассивов с ключами
      <literal>'resource'</literal> и <literal>'events'</literal>.
      Значение ресурса - это (канал) поток или ресурс SSH2 Listener.
      Значением события являются флаги SSH2_POLL*, объединённые побитовым ИЛИ.
      Каждый подмассив будет заполнен элементом <literal>'revents'</literal> при возврате,
      значения которого представляют собой флаги SSH2_POLL*, объединённые
      побитовым ИЛИ совместно с произошедшими событиями.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
      Время ожидания в секундах.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает количество дескрипторов, которые вернули ненулевые повторения.
  </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
-->