ssh2-poll.xml

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

<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>
   チャンネル/リスナー/ストリーム のイベントをポーリングし、
   1個以上のイベントを返したディスクリプタの数を返します。
  </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 リスナーのリソースです。
      イベントの値は、SSH2_POLL* フラグを bitwise OR でまとめて指定します。
      それぞれの配列は、返される際に <literal>'revents'</literal> 要素にまとめられ、
      発生したイベントの SSH2_POLL* フラグが bitwize OR でまとまったものがその値になります。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>timeout</parameter></term>
    <listitem>
     <para>
      タイムアウトさせる時間を秒単位で指定します。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   1個以上のイベントを返したディスクリプタの数を返します。
  </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
-->