array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'fr', ), 'this' => array ( 0 => 'function.ssh2-keepalive-config.php', 1 => 'ssh2_keepalive_config', 2 => 'Configure la fréquence d\'envoi des messages de maintien de connexion', ), 'up' => array ( 0 => 'ref.ssh2.php', 1 => 'Fonctions SSH2', ), 'prev' => array ( 0 => 'function.ssh2-forward-listen.php', 1 => 'ssh2_forward_listen', ), 'next' => array ( 0 => 'function.ssh2-keepalive-send.php', 1 => 'ssh2_keepalive_send', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'fr', 'path' => 'reference/ssh2/functions/ssh2-keepalive-config.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ssh2_keepalive_config

(PECL ssh2 >= 1.5.0)

ssh2_keepalive_config — Configure la fréquence d'envoi des messages de maintien de connexion

Description

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

Configure la fréquence d'envoi des messages de maintien de connexion sur la session fournie, et détermine si une réponse est demandée au serveur.

Les messages de maintien de connexion ne sont pas envoyés automatiquement. Une fois la configuration faite, il faut appeler ssh2_keepalive_send() pour envoyer effectivement un message de maintien de connexion.

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

want_reply

Indique si une réponse aux messages de maintien de connexion est demandée au serveur. Demander une réponse permet de détecter un serveur qui ne répond plus, au prix d'un trafic supplémentaire.

interval

Le nombre de secondes pouvant s'écouler sans aucun trafic avant qu'un message de maintien de connexion ne soit envoyé. La valeur 0 désactive les messages de maintien de connexion, et la valeur 1 est traitée comme 2 par la bibliothèque sous-jacente.

Les valeurs acceptées vont de 0 à 4294967295.

Valeurs de retour

Aucune valeur n'est retournée.

Erreurs / Exceptions

Une erreur de niveau E_WARNING est émise lorsque interval est en dehors de l'intervalle accepté ; dans ce cas, la configuration du maintien de connexion reste inchangée.

Exemples

Exemple #1 Envoi de messages de maintien de connexion

<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');

// Demande une réponse au serveur, après 30 secondes sans aucun trafic
ssh2_keepalive_config($connection, true, 30);

// Les messages de maintien de connexion ne sont envoyés que lors de cet appel
ssh2_keepalive_send($connection);
?>

Voir aussi