array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'es', ), 'this' => array ( 0 => 'function.ssh2-keepalive-send.php', 1 => 'ssh2_keepalive_send', 2 => 'Envía un mensaje de mantenimiento de conexión', ), 'up' => array ( 0 => 'ref.ssh2.php', 1 => 'Funciones de SSH2', ), 'prev' => array ( 0 => 'function.ssh2-keepalive-config.php', 1 => 'ssh2_keepalive_config', ), 'next' => array ( 0 => 'function.ssh2-methods-negotiated.php', 1 => 'ssh2_methods_negotiated', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'es', 'path' => 'reference/ssh2/functions/ssh2-keepalive-send.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ssh2_keepalive_send

(PECL ssh2 >= 1.5.0)

ssh2_keepalive_send — Envía un mensaje de mantenimiento de conexión

Descripción

function ssh2_keepalive_send(resource $session): int|false

Envía un mensaje de mantenimiento de conexión en la session indicada, de acuerdo con la configuración establecida con ssh2_keepalive_config().

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().

Valores devueltos

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 0 cuando los mensajes de mantenimiento de conexión están deshabilitados.

Puesto que tanto 0 como false se evalúan como falso, debe utilizarse el operador === para distinguirlos.

Ejemplos

Ejemplo #1 Envío de un mensaje de mantenimiento de conexión

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

Véase también