Files
Leonardo Lara Rodrigues 4baf074b52 sync file lines with en rev
2026-01-27 09:14:27 -03:00

80 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 12f0e72200ea9249d0fc2f118528bd24b24c44a6 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssh2-poll">
<refnamediv>
<refname>ssh2_poll</refname>
<refpurpose>Pesquisa os canais/ouvintes/transmissões para eventos</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>
<simpara>
Pesquisa os canais/ouvintes/transmissões para eventos,
e retorna o número de descritores que retornaram eventos diferentes de zero.
</simpara>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>desc</parameter></term>
<listitem>
<simpara>
Um array indexado de subarrays com as chaves
<literal>'resource'</literal> e <literal>'events'</literal>.
O valor do recurso é um fluxo (canal) ou um recurso do Listener SSH2.
O valor do evento são as constantes SSH2_POLL* unidas por OR binário.
Cada subarray será preenchido com um elemento <literal>'revents'</literal> no retorno,
cujos valores são as constantes SSH2_POLL* unidas por OR binário dos eventos que ocorreram.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<simpara>
O tempo limite em segundos.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna o número de descritores que retornaram eventos diferentes de zero.
</simpara>
</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
-->