PHP 5.4.36 Released

stream_set_timeout

(PHP 4 >= 4.3.0, PHP 5)

stream_set_timeoutEstablecer un perido de tiempo de espera en un flujo

Descripción

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

Establece el valor del tiempo de espera en stream, expresado como la suma de seconds y microseconds.

Cuando el flujo agota el tiempo de espera, la clave 'timed_out' de la matriz devuelta por stream_get_meta_data() se establece a TRUE, aunque no se genere un error/advertencia.

Parámetros

stream

El flujo objetivo.

seconds

La parte de segundos del tiempo de espera a establecer.

microseconds

La parte de microsegundos del tiempo de espera a establecer.

Valores devueltos

Devuelve TRUE en caso de éxito o FALSE en caso de error.

Historial de cambios

Versión Descripción
4.3.0 A partira de PHP 4.3, esta función pude (potencialmente) trabajar con cualquier tipo de flujos. En PHP 4.3, los sockets basados en flujos son aún el único tipo soportado en el núcleo de PHP, aunque los flujos de otras extensiones pueden soportar esta función.

Ejemplos

Ejemplo #1 Ejemplo de stream_set_timeout()

<?php
$fp 
fsockopen("www.example.com"80);
if (!
$fp) {
    echo 
"No se puede abrir\n";
} else {

    
fwrite($fp"GET / HTTP/1.0\r\n\r\n");
    
stream_set_timeout($fp2);
    
$res fread($fp2000);

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

    if (
$info['timed_out']) {
        echo 
'¡La conexión agotó el tiempo de espera!';
    } else {
        echo 
$res;
    }

}
?>

Notas

Nota:

Esta función no funciona con operaciones avanzadas como stream_socket_recvfrom(), use stream_select() con el parámetro tiempo de espera (timeout) en su lugar.

Esta función se llamaba anteriormente set_socket_timeout() y después socket_set_timeout() pero este uso está obsoleto.

Ver también

  • fsockopen() - Abre una conexión vía sockets a Internet o a un dominio Unix
  • fopen() - Abre un fichero o una URL
add a note add a note

User Contributed Notes 9 notes

up
11
hamishcool3 at yahoo dot co dot uk
4 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
2
Martin Butt - martin at anti_spambutt.cx
7 years ago
Here is a working example for loops:

<?php
// Timeout in seconds
$timeout = 5;

$fp = fsockopen("www.server.com", 80, $errno, $errstr, $timeout);

if (
$fp) {
       
fwrite($fp, "GET /file.php HTTP/1.0\r\n");
       
fwrite($fp, "Host: www.server.com\r\n");
       
fwrite($fp, "Connection: Close\r\n\r\n");

       
stream_set_blocking($fp, TRUE);
       
stream_set_timeout($fp,$timeout);
       
$info = stream_get_meta_data($fp);

        while ((!
feof($fp)) && (!$info['timed_out'])) {
               
$data .= fgets($fp, 4096);
               
$info = stream_get_meta_data($fp);
               
ob_flush;
               
flush();
        }

        if (
$info['timed_out']) {
                echo
"Connection Timed Out!";
        } else {
                echo
$data;
        }
}
?>
up
0
emailfire at gmail dot com
3 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
0
alfi_ at yahoo dot com
8 years ago
If you are using fsockopen() to create a connection, first going to write into the stream and then waiting for the reply (e.g. simulating HTTP request with some extra headers), then stream_set_timeout() must be set only after the write - if it is before write, it has no effect on the read timeout :-(
Noticed at least on PHP/4.3.10
up
0
rtfm61 at yandex dot ru
8 years ago
stream_set_timeout() is not suitable for such files as UNIX-devices (/dev/...), i suggest to use select() instead with desirable timeout value - that works well.
up
0
ridera
9 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.
up
-1
jack.whoami
6 months ago
Just in case someone stumbles into my situation... I was trying to get the microseconds part to work and it just wasn't working as expected.

Assuming blocking mode is true and I use

<?php stream_set_timeout($s, 1, 0);?>

I get a 1s delay as expected. However when I do

<?php stream_set_timeout($s, 0, 500);?>

I expect a 500microsecond delay but I get no delays at all. However when i do this

<?php stream_set_timeout($s, 0, 500000);?>

I get a 500 microsecond delay which is what I was expecting
up
-1
Dianoga (dianoga7 [at] 3dgo.net)
8 years ago
I have found that in order to actually stop the socket from timing out the script, you must call stream_get_meta_data and check for a timeout within the loop reading from the socket.

Example:

<?php
$sock
= fsockopen($host, 80, $errno, $errstr, 30);
if(!
$sock){
    echo
"Unable to get server status";
}else{
   
$out = "GET /server.php HTTP/1.1\r\n";
   
$out .= "Host: $host\r\n";
   
$out .= "Connection: Close\r\n\r\n";

   
fwrite($sock, $out);

   
stream_set_blocking($fp, FALSE );
   
stream_set_timeout($sock, $timeout);
   
$info = stream_get_meta_data($sock);

    while (!
feof($sock) && !$info['timed_out']) {
       
$file .= fgets($sock, 4096);
       
$info = stream_get_meta_data($sock);
    }

   
fclose($sock);
?>
up
-1
mildly dull at terriblyclever dot com
5 years ago
I didn't have much luck with the suggestions below (although I likely applied them wrong).
Instead, I used stream_context_create() and set an http option for timeout. I fed that context into file_get_contents() and voila!

To my desperate friend below: the https transport can also use the http stream context options. I haven't verified this works as I don't have a slow responding ssl to test on. But if you are still stressing, give the below a shot (you may need to modify a bit...)

<?php
    $timeout
= 5*60;
   
$options = array(
         
'http'=>array(
           
'method'=>"GET",
           
'header'=>"Accept-language: en\r\n",
             
'timeout' => $timeout
             
)
        );
   
$context = stream_context_create($options);
   
$contents = file_get_contents($source, false, $context);
?>

Yes...that is a 5 minute timeout.
To Top