Forum PHP 2026 - Paris (France)

ssh2_keepalive_send

(PECL ssh2 >= 1.5.0)

ssh2_keepalive_sendEnvoie un message de maintien de connexion

Description

function ssh2_keepalive_send(resource $session): int|false

Envoie un message de maintien de connexion sur la session fournie, conformément à la configuration définie avec ssh2_keepalive_config().

Note:

Cette fonction n'est disponible que lorsque l'extension est compilée avec une version de libssh2 fournissant le support du maintien de connexion.

Liste de paramètres

session

Un identifiant de lien de connexion SSH, obtenu depuis un appel à ssh2_connect().

Valeurs de retour

Retourne le nombre de secondes pouvant s'écouler avant qu'un nouveau message de maintien de connexion ne doive être envoyé, ou false en cas d'échec. 0 est retourné lorsque les messages de maintien de connexion sont désactivés.

0 et false étant tous deux évalués à faux, l'opérateur === doit être utilisé pour les distinguer.

Exemples

Exemple #1 Envoi d'un message de maintien de connexion

<?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 "Le message de maintien de connexion n'a pas pu être envoyé", PHP_EOL;
} elseif ($seconds === 0) {
    echo "Les messages de maintien de connexion sont désactivés", PHP_EOL;
} else {
    echo "Prochain message de maintien de connexion dans $seconds secondes", PHP_EOL;
}
?>

Voir aussi

add a note

User Contributed Notes

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