Note that reading from a regular file which is on end-of-file will *not* block. You'll get a non-blocking, zero-byte read. However, stream_select *will* block if the input is a pipe, and there is no more data to be had.
stream_select
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
stream_select — Запускает эквивалент системного вызова select() на массивах потоков со временем ожидания в секундах и микросекундах
Описание
stream_select(
?array
?array
?array
?int
?int
): int|false
?array
&$read,?array
&$write,?array
&$except,?int
$seconds,?int
$microseconds = null): int|false
Функция stream_select() принимает массивы потоков и ждёт изменения их статуса. Функция работает так же, как функции socket_select(), за исключением того, что она работает с потоками.
Список параметров
-
read -
Потоки массива
readбудут отслеживаться, чтобы определить, не стали ли символы доступны для чтения (точнее, чтобы понять, не будет ли блокироваться чтение — в качестве конкретного примера, ресурс потока также готов для чтения в конце файла, но тогда функция fread() будет возвращать строку нулевой длины). -
write -
Потоки массива
writeбудут отслеживаться, чтобы определить, не будет ли блокироваться запись. -
except -
Потоки массива
exceptбудут отслеживаться на предмет поступления высокоприоритетных исключительных (внеполосных, или «out-of-band») данных.Замечание:
Когда функция stream_select() возвращает значение, массивы
read,writeиexceptизменяются, чтобы указать, какие ресурсы потоков на самом деле изменили статус. Исходные ключи массивов (array) сохраняются. -
seconds -
Параметры
secondsиmicrosecondsскладываются в параметр timeout,secondsуказывает количество секунд, аmicroseconds— количество микросекунд. Параметрtimeout— это верхняя граница времени, в течение которого функция stream_select() будет ждать, прежде чем вернёт результат. Функция stream_select() не будет ждать данные, если обоим параметрам —secondsиmicroseconds— установлено значение0, вместо этого функция вернёт результат немедленно, указывая текущий статус потоков.Функция stream_select() блокируется на неопределённый срок, если значение параметра
secondsравноnull. Функция возвращается только тогда, когда случается событие на отслеживаемом потоке, или если сигнал прерывает системный вызов.ВниманиеРазработчик может мгновенно опросить статус потоков, если установит значение времени ожидания равное
0, однако, ПЛОХАЯ идея устанавливать значение времени ожидания0в цикле, поскольку тогда скрипт будет потреблять слишком много процессорного времени.Лучше указать значение времени ожидания в несколько секунд, хотя, если нужно проверять и одновременно запускать другой код, установка для времени ожидания значения хотя бы в
200000микросекунд поможет снизить нагрузку скрипта на процессор.При работе с функцией помнят, что значение времени ожидания — это максимальное время, которое пройдёт; функция stream_select() вернёт значение, как только запрошенные потоки будут готовы к работе.
-
microseconds -
Смотрите описание параметра
seconds.
Возвращаемые значения
В случае успешного выполнения функция stream_select()
возвращает количество ресурсов потоков, которые содержится
в изменённых массивах. Значение будет равно нулю,
если время ожидания закончилось до изменений.
При ошибке функция возвращает false
и выдаёт предупреждение — это случится, если системный вызов
будет прерван входящим сигналом.
Список изменений
| Версия | Описание |
|---|---|
| 8.1.0 |
Параметр microseconds теперь принимает значение null.
|
Примеры
Пример #1 Пример использования функции stream_select()
Этот пример проверяет, что получены данные для чтения на потоках
$stream1 или $stream2.
Поскольку значение времени ожидания равно 0, функция возвратится
немедленно:
<?php
/* Подготовить массив для чтения */
$read = array($stream1, $stream2);
$write = NULL;
$except = NULL;
if (false === ($num_changed_streams = stream_select($read, $write, $except, 0))) {
/* Обработка ошибок */
} elseif ($num_changed_streams > 0) {
/* Как минимум на одном из потоков произошли изменения */
}
?>Примечания
Замечание:
Из-за ограничений движка Zend Engine невозможно передать модификатор константы, например, значение
null, в качестве параметра функции, которая ожидает, что этот параметр передадут по ссылке. Вместо этого объявляют временную переменную или записывают выражение с крайним левым членом в качестве временной переменной:<?php
$e = NULL;
stream_select($r, $w, $e, 0);
?>
Замечание:
Ошибку проверяют оператором строгого сравнения
===. Иногда функция stream_select() возвращает значение 0, и сравнение через оператор==вычислится какtrue:<?php
$e = NULL;
if (false === stream_select($r, $w, $e, 0)) {
echo "Произошла ошибка при вызове функции stream_select()\n";
}
?>
Замечание:
При чтении или записи в поток, который возвращается в массивах, учитывают, что поток читает или записывает не полный объём данных, которые запросили. Разработчику лучше быть готовым даже к тому, что получится читать или записывать только один байт.
Замечание:
Ряд потоков нельзя выбрать этой функцией, например, поток модуля
zlib.
Замечание: Совместимость с операционной системой Windows
Вызов функции stream_select() на файловых дескрипторах, которые возвращает функция proc_open() в системах Windows, завершится ошибкой и вернёт
false.При запуске из консоли константа
STDINизменяет статус, как только становятся доступны какие угодно входные события, но процесс по-прежнему может блокировать чтение из потока.
Смотрите также
- stream_set_blocking() - Устанавливает блокирующий или неблокирующий режим для потока
add a note
User Contributed Notes 17 notes
php at richardneill dot org ¶
15 years ago
maartenwolzak at gmail dot com ¶
17 years ago
Note that you should change the calctimeout function below to divide the outcome by 1.000.000 otherwise you'll be waiting for two years instead of one minute for the socket to timeout...
<?php
// The function to calculate the timeout
function calctimeout($maxtime, $starttime)
{
return ($maxtime - ((microtime(true) - $starttime) * 1000000))/1000000;
}
?>
Martin ¶
6 years ago
Maintaining connection with multiple clients can be tricky, PHP script is single-thread process, so if you like to do more than one thing at once (like waiting for new connections and waiting for new data), you’ll have to use some sort of multiplexing.
<?php
$socket = stream_socket_server("tcp://0.0.0.0:8000", $errno, $errstr, STREAM_SERVER_BIND | STREAM_SERVER_LISTEN);
stream_set_blocking($socket, 0);
$connections = [];
$read = [];
$write = null;
$except = null;
while (1) {
// look for new connections
if ($c = @stream_socket_accept($socket, empty($connections) ? -1 : 0, $peer)) {
echo $peer.' connected'.PHP_EOL;
fwrite($c, 'Hello '.$peer.PHP_EOL);
$connections[$peer] = $c;
}
// wait for any stream data
$read = $connections;
if (stream_select($read, $write, $except, 5)) {
foreach ($read as $c) {
$peer = stream_socket_get_name($c, true);
if (feof($c)) {
echo 'Connection closed '.$peer.PHP_EOL;
fclose($c);
unset($connections[$peer]);
} else {
$contents = fread($c, 1024);
echo $peer.': '.trim($contents).PHP_EOL;
}
}
}
}
?>
aidan at php dot net ¶
20 years ago
If you want to set an absolute maximum execution time for stream_select in a loop, it's important to decrement the max_time value passed to stream_select.
<?php
// The maximum time for execution in milliseconds
$maxtime = 200000;
// The time the loop started
$starttime = microtime(true);
// Original array of sockets
$r = $orig_sockets;
// The function to calculate the timeout
function calctimeout($maxtime, $starttime)
{
return $maxtime - ((microtime(true) - $starttime) * 1000000);
}
while (stream_select($r, $w = null, $e = null, 0, calctimeout($maxtime, $starttime)) !== 0)
{
// loop through the sockets that showed activity
foreach ($r as $socket) {
// $socket talked
}
// stream_select modifies the contents of $r
// in a loop we should replace it with the original
$r = $orig_sockets;
}
?>
doingitwrong at mailismagic dot com ¶
9 years ago
If you use stream_select() with a blocking stream, you are doing it wrong!
Just because this function returns something in one or more of the arrays does NOT mean that a future read or write operation will not block.
The above sentence is the most important sentence you will ever read regarding stream manipulation. Using stream_select() with blocking streams is a very common amateur mistake and causes major headaches when tracking down usage of this and similar select() system functions. PHP (and really the underlying OS) should verify that the supplied stream set is not blocking and throw an error/exception if any socket is set to block so that people are forced to fix their code. The documentation for stream_select() is, at best, misleading.
If you want a non-blocking stream, then set the stream to not block. Otherwise, live with the blocking stream. That is, after all, the whole point of blocking - to block indefinitely until the operation completes. select() is built for non-blocking streams ONLY. Any other use will result in very hard to track down bugs.
I got the above lecture many years ago after encountering the very bugs I mention. I fixed my code and now correct similar mistakes when I run into the issue elsewhere. Writing code for non-blocking streams is simpler than trying to write hacks for blocking streams with select() functions and ending up with application bugs.
Sitsofe ¶
5 years ago
When stream_select() fails you SHOULD NOT use the results of the arrays (i.e. read, write, except) that were passed into it as parameters. While doing so anyway won't trigger undefined behaviour, you are depending on unspecified behaviour that by definition is not guaranteed.
At the time of writing the PHP 7.2 interpreter does not modify the arrays upon stream_select() failure (see the code around https://github.com/php/php-src/blob/php-7.2.14/ext/standard/streamsfuncs.c#L842) thus a PHP program that doesn't heed the advice above can deceive itself as to the state of those streams.
(Hopefully this warning can be added to the main documentation one day)
rob at associatedtechs dot com ¶
10 years ago
If you try to use stream_select() with fread(), you may get bit by a combination of bugs (https://bugs.php.net/bug.php?id=52602 and https://bugs.php.net/bug.php?id=51056). As of PHP 5.5.10, fread() and stream_select() don't reliably play well together.
If you need stream_select() and you don't need an encrypted connection (e.g. TLS), use stream_socket_recvfrom() instead of fread().
I can't find a way to reliably handle an encrypted connection with blocking functions in PHP; non-blocking might be the only way to do it.
mark2xv at gmail dot com ¶
11 years ago
If you're getting unexplainable problems with nonblocking sockets using stream_select, disable the buffers using:
stream_set_read_buffer($socket, 0);
stream_set_write_buffer($socket, 0);
For some reason when writing (in total) ~256k, sockets start returning FALSE when reading, yet always appear in the stream_select arrays. This fixed that problem. (for us.)
phpdoc at shemesh dot biz ¶
19 years ago
Please note that, on return, the key of "read" will be zero based, serially numbered according to the streams for which there is read data ready only. In other words, if you want to know which of the original streams placed in "read" is ready, there is no immediate way of knowing that.
If you want to know which of the original stream is which, you can either use "==", or possibly set a reverse map array, in which the stream is the key, and the key to the original "read" array is the data.
lynch at php dot net ¶
14 years ago
Note: At least one of the input arrays must be non-empty, or you get an E_WARNING message:
PHP Warning: stream_select(): unable to select [9]: Bad file descriptor (max_fd=0) in
Ben ¶
17 years ago
You can key on file descriptors just fine by casting them to an int or a string, which returns what you would expect.
aidan at aidans dot org ¶
17 years ago
Note that contrary to what the previous poster said, one is not able to use a stream resource as a key for an array. Rather, if you want to know which socket you are dealing with, consider using code similar to this:
<?php
$sockets = array("sock_1" => $sock1, "sock_2" => $sock2, "sock_3" => $sock_3);
$read = $write = $error = $sockets;
$num = stream_select($read, $write, $error, 10);
if ($n > 0) {
foreach ($read as $r) {
$key = array_search($r, $sockets);
// $key will be "sock_1", "sock_2", "sock_3", etc.
}
}
?>
Hope that helps someone out there!
jerrywilborn at gmail dot com ¶
15 years ago
http://bugs.php.net/bug.php?id=42682
This function will not return the number of changed streams under certain systems with older versions, but instead it will return '0'. Be careful.
asphp at dsgml dot com ¶
8 years ago
Make sure not to pass the same variable in the 3 arguments to stream_select, or you'll only get the results from one of them and the others will be overwritten.
bluej100@gmail ¶
17 years ago
@mbaynton at gmail dot com
A handy syntactic trick:
<?php
$r = Array($stream1, $stream2);
stream_select($r, $w = null, $x = null, 1337);
?>
I've seen it recommended elsewhere in the documentation for clarifying magic arguments so maintainers don't have to go check the function itself, but it also solves your problem here.
aks at esoft dot dk ¶
14 years ago
stream_select() looks deceptively like a simple wrapper around POSIX select(2).
But beware: while select(2) allows you to pass no file descriptors and use it as a "portable subsecond sleep", PHP will complain with "Warning: stream_select(): No stream arrays were passed in ****" if all arrays are empty or null, and it WONT sleep, it will return immediately. So... if the number of file descriptors you have isn't static, you have to deal with the special case yourself.
Maxdamantus ¶
17 years ago
Simple stream_select wrapper.. Returns the first stream in the array, and sets parameter 2 to the key (So that it is easy to identify what received data):
<?php
function select($array, &$vkey, $timeout=0){
$select = array();
$null = NULL;
foreach($array as $key => $sock){
$x = count($select);
$select[$x] = $sock;
$keys[$x] = $key;
}
if(stream_select($select, $null, $null, $timeout)){
foreach($keys as $key){
if($array[$key] == $select[0]){
$vkey = $key;
return($select[0]);
}
}
}
}
$streams = array("foo" => $stream_one, "bar" => $stream_two); // Create an array of two (already existant) streams.
if($new = select($streams, $key, 60)){ //Sets $new to the resource that next gets new data, and $key to either "foo", or "bar", depending which one it is.
echo $key.":".stream_get_line($new, 2048)."\n";
}
?>
