Forum PHP 2026 - Paris (France)

ssh2_keepalive_config

(PECL ssh2 >= 1.5.0)

ssh2_keepalive_configConfigura la frecuencia de envío de los mensajes de mantenimiento de conexión

Descripción

function ssh2_keepalive_config(resource $session, bool $want_reply, int $interval): void

Configura con qué frecuencia se envían los mensajes de mantenimiento de conexión en la session indicada, y si se solicita al servidor que responda a ellos.

Los mensajes de mantenimiento de conexión no se envían automáticamente. Una vez configurados, se debe llamar a ssh2_keepalive_send() para enviar realmente un mensaje de mantenimiento de conexión.

Nota:

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.

Parámetros

session

Un identificador de enlace de conexión SSH, obtenido de una llamada a ssh2_connect().

want_reply

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.

interval

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 0 deshabilita los mensajes de mantenimiento de conexión, y el valor 1 es tratado como 2 por la biblioteca subyacente.

Los valores aceptados van de 0 a 4294967295.

Valores devueltos

No se retorna ningún valor.

Errores/Excepciones

Se emite un error de nivel E_WARNING cuando interval queda fuera del rango aceptado; en ese caso la configuración del mantenimiento de conexión permanece sin cambios.

Ejemplos

Ejemplo #1 Envío de mensajes de mantenimiento de conexión

<?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);
?>

Véase también

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top