com doc/ja: Basic documentation for missing ssh2 functions and constants: reference/ssh2/constants.xml reference/ssh2/functions/ssh2-forward-accept.xml reference/ssh2/functions/ssh2-forward-listen.xml reference/ssh2/functions/ssh2-poll.xml

[email protected] (Yoshinari Takaoka) Fri, 15 Jan 2021 12:54:23 +0000
Newsgroups php.doc.ja
Message-ID <[email protected]>
Commit:    ba4bccf0a438433652c28822671ed88902d100e4
Author:    Yoshinari Takaoka <[email protected]>         Fri, 15 Jan 2021 21:54:23 +0900
Parents:   7609150143beb073712817e408c5c8cd898c3dc5
Branches:  master

Link:       http://git.php.net/?p=doc/ja.git;a=commitdiff;h=ba4bccf0a438433652c28822671ed88902d100e4

Log:
Basic documentation for missing ssh2 functions and constants

Changed paths:
  M  reference/ssh2/constants.xml
  A  reference/ssh2/functions/ssh2-forward-accept.xml
  A  reference/ssh2/functions/ssh2-forward-listen.xml
  A  reference/ssh2/functions/ssh2-poll.xml
diff_ba4bccf0a438433652c28822671ed88902d100e4.txt (text/plain, 11 KB)
diff --git a/reference/ssh2/constants.xml b/reference/ssh2/constants.xml
index e63a548889..63a16597d6 100644
--- a/reference/ssh2/constants.xml
+++ b/reference/ssh2/constants.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: shimooka Status: ready -->
+<!-- EN-Revision: 37323ead9517a89b21bd17913c4fa04a9d713f16 Maintainer: shimooka Status: ready -->
+<!-- Credits: mumumu -->
 <appendix xml:id="ssh2.constants" xmlns="http://docbook.org/ns/docbook">
  &reftitle.constants;
  &extension.constants;
@@ -148,6 +149,96 @@
     </simpara>
    </listitem>
   </varlistentry>
+  <varlistentry xml:id="constant.ssh2-pollin">
+   <term>
+    <constant>SSH2_POLLIN</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-pollext">
+   <term>
+    <constant>SSH2_POLLEXT</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-pollout">
+   <term>
+    <constant>SSH2_POLLOUT</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-pollerr">
+   <term>
+    <constant>SSH2_POLLERR</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-pollhub">
+   <term>
+    <constant>SSH2_POLLHUP</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-pollnval">
+   <term>
+    <constant>SSH2_POLLNVAL</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-poll-session-closed">
+   <term>
+    <constant>SSH2_POLL_SESSION_CLOSED</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-poll-channel-closed">
+   <term>
+    <constant>SSH2_POLL_CHANNEL_CLOSED</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.ssh2-poll-listener-closed">
+   <term>
+    <constant>SSH2_POLL_LISTENER_CLOSED</constant>
+     (<type>int</type>)
+   </term>
+   <listitem>
+    <simpara>
+    </simpara>
+   </listitem>
+  </varlistentry>
  </variablelist>
 </appendix>
 
diff --git a/reference/ssh2/functions/ssh2-forward-accept.xml b/reference/ssh2/functions/ssh2-forward-accept.xml
new file mode 100644
index 0000000000..7f8f52d97b
--- /dev/null
+++ b/reference/ssh2/functions/ssh2-forward-accept.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 37323ead9517a89b21bd17913c4fa04a9d713f16 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="function.ssh2-forward-accept" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ssh2_forward_accept</refname>
+  <refpurpose>リスナーによって作られた接続を受け付ける</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_forward_accept</methodname>
+   <methodparam><type>resource</type><parameter>listener</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   リスナーによって作られた接続を受け付けます。
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>desc</parameter></term>
+    <listitem>
+     <para>
+      SSH2 リスナーのリソースを指定します。
+      これは、<function>ssh2_forward_listen</function> を呼び出すことで得られます。
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   ストリームリソースを返します。
+   &return.falseforfailure;.
+  </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
+-->
diff --git a/reference/ssh2/functions/ssh2-forward-listen.xml b/reference/ssh2/functions/ssh2-forward-listen.xml
new file mode 100644
index 0000000000..fd2383366f
--- /dev/null
+++ b/reference/ssh2/functions/ssh2-forward-listen.xml
@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 37323ead9517a89b21bd17913c4fa04a9d713f16 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="function.ssh2-forward-listen" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ssh2_forward_listen</refname>
+  <refpurpose>リモートサーバ上のポートにバインドし、接続を待つ</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_forward_listen</methodname>
+   <methodparam><type>resource</type><parameter>session</parameter></methodparam>
+   <methodparam><type>int</type><parameter>port</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>host</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>max_connections</parameter><initializer>16</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   リモートサーバ上のポートにバインドし、接続を待ちます。
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>session</parameter></term>
+    <listitem>
+     <para>
+      SSH セッションのリソースを指定します。
+      この値は、<function>ssh2_connect</function> を呼び出すことで得られます。
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>port</parameter></term>
+    <listitem>
+     <para>
+      リモートサーバ上のポート番号を指定します。
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>host</parameter></term>
+    <listitem>
+     <para>
+
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>max_connections</parameter></term>
+    <listitem>
+     <para>
+
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   SSH2 リスナーを返します。
+   &return.falseforfailure;.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>ssh2_forward_accept</function></member>
+  </simplelist>
+ </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
+-->
diff --git a/reference/ssh2/functions/ssh2-poll.xml b/reference/ssh2/functions/ssh2-poll.xml
new file mode 100644
index 0000000000..eac5197a4c
--- /dev/null
+++ b/reference/ssh2/functions/ssh2-poll.xml
@@ -0,0 +1,83 @@
+<?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
+-->