Forum PHP 2026 - Paris (France)

ssh2_set_timeout

(PECL ssh2 >= 1.5.0)

ssh2_set_timeoutSet the timeout for blocking operations on a session

Description

function ssh2_set_timeout(resource $session, int $seconds, int $microseconds = 0): void

Sets how long a blocking operation on the given session may wait before it is considered to have timed out.

When the resulting timeout is 0, which is the default, no timeout is applied and blocking operations may wait indefinitely.

Parameters

session

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

seconds

The timeout, in seconds.

microseconds

An additional number of microseconds added to the timeout. The underlying library only supports millisecond precision, so this value is rounded up to the next whole millisecond.

Return Values

No value is returned.

Examples

Example #1 Limiting how long blocking operations may wait

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

// Give up on blocking operations after 5.5 seconds
ssh2_set_timeout($connection, 5, 500000);

ssh2_auth_password($connection, 'username', 'password');
?>

See Also

add a note

User Contributed Notes

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