大网数据广告活动
PHP 语言与运行手册

ssh2_keepalive_send · Send a keepalive message

· 52CE 我爱测

ssh2_keepalive_send — Send a keepalive message

ssh2_keepalive_send

(PECL ssh2 >= 1.5.0)

ssh2_keepalive_send — Send a keepalive message

Description

function ssh2_keepalive_send(resource $session): int|false

Sends a keepalive message on the given session, according to the configuration set with ssh2_keepalive_config().

Note:

This function is only available when the extension is built against a libssh2 version providing keepalive support.

Parameters

session

An SSH connection link identifier, obtained from a call to ssh2_connect().

Return Values

Returns the number of seconds that may pass before another keepalive message must be sent, or false on failure. 0 is returned when keepalive messages are disabled.

Since 0 and false are both falsy, the === operator has to be used to tell them apart.

Examples

Example #1 Sending a keepalive message

<?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 "The keepalive message could not be sent", PHP_EOL;
} elseif ($seconds === 0) {
    echo "Keepalive messages are disabled", PHP_EOL;
} else {
    echo "Next keepalive message due in $seconds seconds", PHP_EOL;
}
?>

See Also

来源:PHP Documentation Group · 作者与贡献记录 · CC BY 3.0。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
PHP Documentation Group
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 3.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。