stream_select

(PHP 4 >= 4.3.0, PHP 5)

stream_select — Ejecuta el equivalente de la llamada al sistema select() sobre las matrices de flujos dadas con un tiempo de espera especificado por tv_sec y tv_usec

Descripción

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

La función stream_select() acepta matrices de flujos y espera a que cambien su estado. Su operación es equivalente a la de la función socket_select() excepto que actúa sobre flujos.

Parámetros

read

Los flujos listados en la matriz read serán observados para comprobar si los caracteres están disponibles para la lectura (de manera más precisa, para ver si una lectura no bloqueará - en particular, un recurso de flujo está también listo en el final de archivo, en cuyo caso una llamada a fread() devolverá una cadena de longitud cero).

write

Los flujos listados en la matriz write serán observados para comprobar si una escritura no bloqueará.

except

Los flujos listados en la matriz except serán observados para una llegada de información excepcional de alta prioridad ("fuera de banda").

Nota:

Cuando stream_select() devuelve, las matrices read, write y except se modifican para indicar qué recursos de flujo cambiaron de estado actualmente.

No se necesita pasar cada matriz a stream_select(). Se pueden omitir y usar una matriz vacía o NULL en su lugar. No se olvide también de que estas matrices son pasadas por referencia y serán modificadas después de que stream_select() devuelva.
tv_sec

Los parámetros tv_sec y tv_usec forman juntos el parámetro timeout, tv_sec especifica el número de segundos mientras que tv_usec especifica el número de microsegundos. El timeout (tiemop de espera) es un límite superior de la cantidad de tiempo que stream_select() esperará antes de devolver. Si tv_sec y tv_usec están establecidos a 0, stream_select() no esperará información - en su lugar devolverá inmediantamente, indicando el estado acutal de los flujos.

Si tv_sec es NULL stream_select() puede bloquear indefinidamente, devolviendo sólo cuando ocurra un evento de los flujos observados (o si una señal interrumpe la llamada al sistema).

Advertencia

Usar un valor de tiempo de espera de 0 permite emitir instantáneamente el estado de los flujos, sin embargo, NO es una buena idea usar un valor de tiempo de espera de 0 en un bucle ya que causará que el script consuma demasiado tiempo de la CPU.

Es mucho mejor especificar un valor de tiempo de espera de unos pocos segundos, aunque si se necesita comprobar y ejecutar actualmente otro código, usar un valor de tiempo de espera de al menos 200000 microsegundos ayudará a reducir el uso de la CPU del script.

Recuerde que el valor del tiempo de espera es el tiempo máximo que transcurrirá; stream_select() devolverá tan pronto como los flujos requeridos estén listos para su uso.

tv_usec

Véase la descripción de tv_sec.

Valores devueltos

Si se tuvo éxito stream_select() devolverá el número de recursos de flujo contenidos en las matrices modificadas, lo cual puede ser cero si el tiempo de espera expira antes de que no ocurra nada interesante. Si se produjo un error devolverá FALSE y se lanzará una advertendia (esto puede suceder si la llamada al sistema es interrumpida por una señal entrante).

Ejemplos

Ejemplo #1 Ejemplo de stream_select()

Este ejemplo hace una comprobación para ver si ha llegado información para leer sobre $stream1 o $stream2. Ya que el tiempo de espera es 0 devolverá inmediatamente:

<?php
/* Prepararse para leer una matriz */
$read   = array($stream1, $stream2);
$write  = NULL;
$except = NULL;
if (false === ($num_changed_streams = stream_select($read, $write, $except, 0))) {
    /* Manejo de errores */
} elseif ($num_changed_streams > 0) {
    /* Sucedió algo interesante en al menos uno de los flujos */
}
?>

Notas

Nota:

Debido a las limitaciones en el actual Zend Engine no es posible pasar un modificador constante como NULL directamente como un parámetro a una función que espera que este parámetro sea pasado por referencia. En su lugar use una variable temporal o una expresión con el miembro más a la izquierda como una variable temporal:

<?php
$e = NULL;
stream_select($r, $w, $e, 0);
?>

Nota:

Asegúrese de usar el operador === cuando se compruebe un error. Ya que stream_select() puede devolver 0, la comparación con == sería evaluada como TRUE:

<?php
$e = NULL;
if (false === stream_select($r, $w, $e, 0)) {
    echo "Falló stream_select()\n";
}
?>

Nota:

Si se lee/escribe en un flujo devuelto en las matrices sea consciente de que éstas no leen/escriben necesariamente la cantidad total de información que se solicitó. Inluso sólo pueden ser capaces de leer/escribir un sólo byte.

Nota:

Algunos flujos (como zlib) no pueden ser seleccionados por esta función.

Nota:

Compatibilidad con Windows: stream_select() usado sobre una tubería devuelta desde proc_open() puede causar pérdida de información bajo Windows 98.

El uso de stream_select() sobre descriptores de archivos devueltos por proc_open() fallará y devolverá FALSE bajo Windows.

Ver también