PHP 5.5.17 is available

stream_select

(PHP 4 >= 4.3.0, PHP 5)

stream_selectselect() システムコールと同等の操作を、 ストリームの配列に対して tv_sec と tv_usec で指定されたタイムアウト時間をもって行う

説明

int stream_select ( array &$read , array &$write , array &$except , int $tv_sec [, int $tv_usec = 0 ] )

stream_select() はストリームの配列を受け取ると、 それらの状態が変化するまで待ちます。機能としては、ストリームに対して 働くという点以外では socket_select() と同一です。

パラメータ

read

read 配列に列挙されたストリームに対しては、 何らかのデータがそのストリーム内で読み出せる状態にあるかどうか 監視が行われます (より正確にいえば、ブロックしないで読み出せる状態かどうか - 特にストリームが EOF に達したかどうか、です。このとき、 fread() は長さ 0 の文字列を返します)。

write

write 配列に列挙されたストリームに対しては、 ブロックしないで書き込みができるかどうかの監視が行われます。

except

except 配列に列挙されたストリームに対しては、 重大な例外("帯域外の")データが発生したかどうかの監視が行われます。

注意:

stream_select() の終了時には、 どのストリームの状態が実際に変化したのかが分かるよう、 配列 readwrite および except に変更が加えられます。

stream_select() のすべてのパラメータに配列を 渡す必要はありません。代わりに そのままにしておくことも、空の配列を渡すことも、NULL を渡すことも できます。このとき、それらの変数は参照渡しで渡されるため、 stream_select() から戻った時点で変更されている 可能性があることに注意してください。
tv_sec

tv_sectv_usec は、一体となって、timeout パラメータを表現します。 tv_sec は秒数を指定し、一方 tv_usec はマイクロ秒数を指定します。 timeout は、stream_select() の実行から戻るまでの時間の上限です。 tv_sec および tv_usec の両方に 0 を指定すると stream_select() はデータを待たずに一瞬で戻ります。 これは現在のストリームの状態を示します。

tv_secNULL (タイムアウトなし) の場合、 stream_select() はブロックしつづけ、調べている ストリームのひとつでイベントが発生する(あるいはシグナルがシステム コールを中断する)まで終了しません。

警告

タイムアウト値に 0 を指定すると、ストリームの 状態を即時に取得することが可能です。しかし、ループ内でタイムアウト 0 を指定するのは良い考えではありません。 そうすると大量の CPU 時間を消費してしまいます。

タイムアウト値を数秒にするとかなりましになります。しかし、どうしても 他のコードを同時に実行させながらチェックをする必要がある場合には、 少なくとも 200000 マイクロ秒以上のタイムアウトを 設定するようにしましょう。これであなたのスクリプトの CPU 使用量を 抑えることができます。

タイムアウト値は、あくまでも経過時間の最大値であることを覚えておきましょう。 stream_select() は、指定したストリームが使用可能に なるとすぐに結果を返します。

tv_usec

tv_sec の説明を参照ください。

返り値

成功した場合 stream_select() は、変更された 配列に何個のストリームリソースが格納されたかを示す数を返します。 もしタイムアウトの時間内に何も規定された事象が起こらなかった場合は 0 になることもあります。エラーの際は FALSE を返し、警告を発生させます (システムコールが別のシグナルによって中断された場合などに起こりえます)。

例1 stream_select() の例

この例では、$stream1 あるいは $stream2 のどちらかに読み込めるデータが 到達したかどうかを調べます。 タイムアウトが 0 なので、すぐに結果を返します。

<?php
/* read 配列を用意 */
$read   = array($stream1$stream2);
$write  NULL;
$except NULL;
if (
false === ($num_changed_streams stream_select($read$write$except0))) {
    
/* エラー処理 */
} elseif ($num_changed_streams 0) {
    
/* 少なくとも 1 つのストリームに何らかの事象が起こりました。*/
}
?>

注意

注意:

現在の Zend Engine の実装上の制約により、NULL のような定数を この関数の参照渡しが行われるパラメータに直接指定することはできません。 代わりに一時的な変数を指定するか、一番左の変数が一時的な変数になるような 式を指定してください:

<?php
$e 
NULL;
stream_select($r$w$e0);
?>

注意:

エラーかどうかをチェックするには === を使ってください。 stream_select() は 0 を返すことがあるため、その場合 FALSE== 演算子で比較すると TRUE と評価されてしまうからです:

<?php
$e 
NULL;
if (
false === stream_select($r$w$e0)) {
    echo 
"stream_select() に失敗しました\n";
}
?>

注意:

配列に返されたストリームに対して読み込みまたは書き込み操作を行う際に、 必ずしもあなたの希望しただけデータが読まれたり書かれたりはしないことに 注意してください。たった 1 バイトしか読み出せない場合も、書き込めない 場合もあるのです。

注意:

ストリームの中には、(zlib などのように) この関数で select できないものもあります。

注意:

Windows の互換性: Windows 98 では、 proc_open() が返すパイプに対して stream_select() を使用すると データが失われる可能性があります。

Windows では、proc_open() が返すファイル記述子に 対して stream_select() を使用すると 失敗して FALSE を返すことがあります。

参考

add a note add a note

User Contributed Notes 13 notes

up
2
Ben
7 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.
up
2
aidan at aidans dot org
7 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!
up
2
maartenwolzak at gmail dot com
7 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;
}

?>
up
2
phpdoc at shemesh dot biz
9 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.
up
2
aidan at php dot net
10 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;
}

?>
up
1
aks at esoft dot dk
3 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.
up
1
lynch at php dot net
4 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
up
1
jerrywilborn at gmail dot com
5 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.
up
1
php at richardneill dot org
5 years ago
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.
up
1
Maxdamantus
6 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";
}
?>
up
1
bluej100@gmail
7 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.
up
0
rob at associatedtechs dot com
2 months 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.
up
0
mark2xv at gmail dot com
1 year 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.)
To Top