PHP 8.4.1 Released!

stream_set_timeout

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

stream_set_timeoutУстанавливает значение времени ожидания для потока

Описание

stream_set_timeout(resource $stream, int $seconds, int $microseconds = 0): bool

Функция устанавливает значение времени ожидания в потоке stream, которое равно сумме параметров seconds и microseconds.

Когда время работы потока истекает, ключ timed_out массива, который возвращает функция stream_get_meta_data(), устанавливается в значение true, хотя ошибка или предупреждение не генерируется.

Список параметров

stream

Целевой поток.

seconds

Секунды в устанавливаемом времени ожидания.

microseconds

Микросекунды в устанавливаемом времени ожидания.

Возвращаемые значения

Функция возвращает true в случае успешного выполнения или false, если возникла ошибка.

Примеры

Пример #1 Пример использования функции stream_set_timeout()

<?php

$fp
= fsockopen("www.example.com", 80);

if (!
$fp) {
echo
"Невозможно открыть сокет\n";
} else {
fwrite($fp, "GET / HTTP/1.0\r\n\r\n");
stream_set_timeout($fp, 2);
$res = fread($fp, 2000);

$info = stream_get_meta_data($fp);
fclose($fp);

if (
$info['timed_out']) {
echo
'Истекло время соединения!';
} else {
echo
$res;
}
}

?>

Примечания

Замечание:

Эта функция не работает с продвинутыми операциями наподобие stream_socket_recvfrom(). Вместо неё вызывают функцию stream_select() с параметром времени ожидания.

Эта функция раньше вызывалась через функцию set_socket_timeout() и позднее через функцию socket_set_timeout(), но это устарело.

Смотрите также

  • fsockopen() - Открывает соединение с сокетом интернет- или Unix-домена
  • fopen() - Открывает файл или URL-адрес
Добавить

Примечания пользователей 4 notes

up
25
hamishcool3 at yahoo dot co dot uk
14 years ago
In case anyone is puzzled, stream_set_timeout DOES NOT work for sockets created with socket_create or socket_accept. Use socket_set_option instead.

Instead of:
<?php
stream_set_timeout
($socket,$sec,$usec);
?>

Use:
<?php
socket_set_option
($socket, SOL_SOCKET, SO_RCVTIMEO, array('sec'=>$sec, 'usec'=>$usec));
socket_set_option($socket, SOL_SOCKET, SO_SNDTIMEO, array('sec'=>$sec, 'usec'=>$usec));
?>
up
1
burninleo at gmx dot net
8 years ago
Another note alread states that blocking-reads may be an issue, if the counterpart responds very slowly - or not at all. The stream timeout may not work as expected in such a situation.

However, php.net provides very little information on how to use non-blocking reading operations. Here's a code sample:

<?php
stream_set_timeout
($c, $timeout);
$data = '';
while (
is_resource($c) && !feof($c)) {
// Use non-blocking reading for first loop
if (($data === '') and ($timeout > 0)) {
stream_set_blocking($c, false);
$endtimeOut = time() + $timeout;
$str = '';
while ((
time() < $endtimeOut) and (strlen($str) < 515) and !feof($c)) {
sleep(1); // Note: This may require tuning
$str.= fgets($c, 515);
}
// Handling first-read timeout
if (time() >= $endtimeOut) {
trigger_error('Timeout', E_USER_WARNING);
break;
}
stream_set_blocking($c, true);
} else {
$str = fgets($c, 515);
}
$data.= $str;

// Handling of "traditional" timeout
$info = stream_get_meta_data($c);
if (
$info['timed_out']) {
trigger_error('Timeout', E_USER_WARNING);
break;
}
}
?>
up
1
emailfire at gmail dot com
13 years ago
This function seems to have no effect when running as a CLI script, see http://bugs.php.net/bug.php?id=36030
up
1
ridera
19 years ago
I have found it required to add

"stream_set_blocking($fp, FALSE )"

prior to any fgets(), fread(), etc. to prevent the code from hanging up when remote files are called and the response is slow.
To Top