mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 21:38:56 +00:00
81 lines
2.3 KiB
XML
81 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Poll the channels/listeners/streams for events</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>
|
|
Polls the channels/listeners/streams for events,
|
|
and returns the number of descriptors which returned non-zero revents.
|
|
</para>
|
|
|
|
&warn.undocumented.func;
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>desc</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An indexed array of subarrays with the keys
|
|
<literal>'resource'</literal> and <literal>'events'</literal>.
|
|
The value of the resource is a (channel) stream or an SSH2 Listener resource.
|
|
The value of the event are SSH2_POLL* flags bitwise ORed together.
|
|
Each subarray will be populated with an <literal>'revents'</literal> element on return,
|
|
whose values are SSH2_POLL* flags bitwise ORed together of the events that occurred.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>timeout</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The timeout in seconds.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the number of descriptors which returned non-zero revents.
|
|
</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
|
|
-->
|