Skip to content

[Sync-En] ssh2: translate five previously undocumented functions #1199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PhilDaiguille merged 1 commit into from
Sep 1, 2026
Merged

[Sync-En] ssh2: translate five previously undocumented functions #1199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions reference/ssh2/functions/ssh2-auth-agent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 12f0e72200ea9249d0fc2f118528bd24b24c44a6 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<!-- EN-Revision: 3c1b1141df03aeb2633273aeef9aaa9de8619221 Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-agent">
<refnamediv>
<refname>ssh2_auth_agent</refname>
Expand All @@ -21,7 +19,7 @@
<note>
<simpara>
La función <function>ssh2_auth_agent</function> solo está disponible
cuando la extensión ssh2 ha sido compilada con libssh &gt;= 1.2.3.
cuando la extensión ssh2 ha sido compilada con libssh2 &gt;= 1.2.3.
</simpara>
</note>
</refsect1>
Expand Down
6 changes: 2 additions & 4 deletions reference/ssh2/functions/ssh2-auth-pubkey-file.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<!-- EN-Revision: 3c1b1141df03aeb2633273aeef9aaa9de8619221 Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey-file">
<refnamediv>
<refname>ssh2_auth_pubkey_file</refname>
Expand Down Expand Up @@ -106,7 +104,7 @@ if (ssh2_auth_pubkey_file($connection, 'username',
&reftitle.notes;
<note>
<simpara>
La biblioteca libssh subyacente no soporta muy limpiamente las
La biblioteca libssh2 subyacente no soporta muy limpiamente las
autenticaciones parciales. Es decir, que si debe proporcionar a la
vez una clave pública y una contraseña, entonces parecerá como si
la función estuviera en error. En este caso particular, un error en esta
Expand Down
6 changes: 2 additions & 4 deletions reference/ssh2/functions/ssh2-auth-pubkey.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 74ef2355c59e814d14f75a0792d22727be72f137 Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<!-- EN-Revision: 3c1b1141df03aeb2633273aeef9aaa9de8619221 Maintainer: lacatoire Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-auth-pubkey">
<refnamediv>
<refname>ssh2_auth_pubkey</refname>
Expand Down Expand Up @@ -108,7 +106,7 @@ if (ssh2_auth_pubkey($connection, 'username',
&reftitle.notes;
<note>
<simpara>
La biblioteca libssh subyacente no soporta muy limpiamente las
La biblioteca libssh2 subyacente no soporta muy limpiamente las
autenticaciones parciales. Es decir, que si debe proporcionar a la
vez una clave pública y una contraseña, entonces parecerá como si
la función estuviera en error. En este caso particular, un error en esta
Expand Down
142 changes: 142 additions & 0 deletions reference/ssh2/functions/ssh2-keepalive-config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3c1b1141df03aeb2633273aeef9aaa9de8619221 Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.ssh2-keepalive-config" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ssh2_keepalive_config</refname>
<refpurpose>Configura la frecuencia de envío de los mensajes de mantenimiento de conexión</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>ssh2_keepalive_config</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>bool</type><parameter>want_reply</parameter></methodparam>
<methodparam><type>int</type><parameter>interval</parameter></methodparam>
</methodsynopsis>
<simpara>
Configura con qué frecuencia se envían los mensajes de mantenimiento de
conexión en la <parameter>session</parameter> indicada, y si se solicita al
servidor que responda a ellos.
</simpara>
<simpara>
Los mensajes de mantenimiento de conexión no se envían automáticamente. Una
vez configurados, se debe llamar a <function>ssh2_keepalive_send</function>
para enviar realmente un mensaje de mantenimiento de conexión.
</simpara>
<note>
<simpara>
Esta función solo está disponible cuando la extensión se compila con una
versión de libssh2 que proporciona soporte de mantenimiento de conexión.
</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
Un identificador de enlace de conexión SSH, obtenido de una llamada a
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>want_reply</parameter></term>
<listitem>
<simpara>
Indica si se solicita al servidor que responda a los mensajes de
mantenimiento de conexión. Solicitar una respuesta permite detectar un
servidor que no responde, a costa de algo de tráfico adicional.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>interval</parameter></term>
<listitem>
<simpara>
El número de segundos que pueden transcurrir sin ningún tráfico antes de
que deba enviarse un mensaje de mantenimiento de conexión. El valor
<literal>0</literal> deshabilita los mensajes de mantenimiento de
conexión, y el valor <literal>1</literal> es tratado como
<literal>2</literal> por la biblioteca subyacente.
</simpara>
<simpara>
Los valores aceptados van de <literal>0</literal> a
<literal>4294967295</literal>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.void;
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Se emite un error de nivel <constant>E_WARNING</constant> cuando
<parameter>interval</parameter> queda fuera del rango aceptado; en ese caso
la configuración del mantenimiento de conexión permanece sin cambios.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Envío de mensajes de mantenimiento de conexión</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');

// Solicita una respuesta del servidor, tras 30 segundos sin ningún tráfico
ssh2_keepalive_config($connection, true, 30);

// Los mensajes de mantenimiento de conexión solo se envían en esta llamada
ssh2_keepalive_send($connection);
?>
]]>
</programlisting>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_keepalive_send</function></member>
<member><function>ssh2_connect</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
-->
112 changes: 112 additions & 0 deletions reference/ssh2/functions/ssh2-keepalive-send.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3c1b1141df03aeb2633273aeef9aaa9de8619221 Maintainer: lacatoire Status: ready -->
<refentry xml:id="function.ssh2-keepalive-send" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ssh2_keepalive_send</refname>
<refpurpose>Envía un mensaje de mantenimiento de conexión</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>ssh2_keepalive_send</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
</methodsynopsis>
<simpara>
Envía un mensaje de mantenimiento de conexión en la
<parameter>session</parameter> indicada, de acuerdo con la configuración
establecida con <function>ssh2_keepalive_config</function>.
</simpara>
<note>
<simpara>
Esta función solo está disponible cuando la extensión se compila con una
versión de libssh2 que proporciona soporte de mantenimiento de conexión.
</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
Un identificador de enlace de conexión SSH, obtenido de una llamada a
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Devuelve el número de segundos que pueden transcurrir antes de que deba
enviarse otro mensaje de mantenimiento de conexión, o &false; en caso de
error. Devuelve <literal>0</literal> cuando los mensajes de mantenimiento de
conexión están deshabilitados.
</simpara>
<simpara>
Puesto que tanto <literal>0</literal> como &false; se evalúan como falso,
debe utilizarse el operador <literal>===</literal> para distinguirlos.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Envío de un mensaje de mantenimiento de conexión</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
ssh2_keepalive_config($connection, true, 30);

$seconds = ssh2_keepalive_send($connection);

if ($seconds === false) {
echo "No se ha podido enviar el mensaje de mantenimiento de conexión", PHP_EOL;
} elseif ($seconds === 0) {
echo "Los mensajes de mantenimiento de conexión están deshabilitados", PHP_EOL;
} else {
echo "Próximo mensaje de mantenimiento de conexión en $seconds segundos", PHP_EOL;
}
?>
]]>
</programlisting>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_keepalive_config</function></member>
<member><function>ssh2_connect</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
-->
Loading