When omitting the parameter $maxlength, any received bytes are stacked up until the underlying stream is not readable anymore, the the function returns that stack in one piece.
stream_get_contents
(PHP 5)
stream_get_contents — Transfiere el resto de un flujo a una cadena
Descripción
Idéntica a file_get_contents(), excepto que stream_get_contents() opera sobre un recurso de flujo ya abierto y devuelve el resto del contenido en una cadena, hasta maxlength bytes y comenzando por el offset especificado.
Parámetros
- handle (resource)
-
Un recurso de flujo (p.ej. devuelto desde fopen())
- maxlength (integer)
-
El máximo de bytes a leer. Por defecto es -1 (lee todo el buffer restante).
- offset (integer)
-
Busca el índice especificado antes de leer. Si este número es negativo, no se hará ninguna búsqueda y la lectura comenzará desde la posición actual.
Valores devueltos
Devuelve una cadena o FALSE en caso de error.
Historial de cambios
| Versión | Descripción |
|---|---|
| 5.1.0 | Se añadió el parámetro offset. |
Ejemplos
Example #1 Ejemplo de stream_get_contents()
<?php
if ($stream = fopen('http://www.example.com', 'r')) {
// imprimir toda la página empezando por el índice 10
echo stream_get_contents($stream, -1, 10);
fclose($stream);
}
if ($stream = fopen('http://www.example.net', 'r')) {
// imprimir los 5 primeros bytes
echo stream_get_contents($stream, 5);
fclose($stream);
}
?>
Notas
Note: Esta función es segura binariamente.
Ver también
- fgets() - Obtiene un línea del puntero a un archivo
- fread() - Lectura de un fichero en modo binario seguro
- fpassthru() - Escribe toda la información restante de un puntero a un archivo
some times this functions cause an max execution time time error, Why?
Simple, if you use it the function wait for have the specified byte length into the resource or the end of file, but, several times this not happend, so we need implement an artificial flag like this:
$tmp = stream_get_contents($this->socket, 42);
while($tmp[42] != 'N'){
//Your code...
$tmp = stream_get_contents($this->socket, 42);
}
Per wez (at php.net), "the trick is to tell the recipient how big the packet is, so that it can read the correct length."
In my own experience, when using PHP streams to send data bursts, the "max length" parameter seems to act more as an exact length parameter, as the stream will block indefinitely until max length is reached or until the other side fcloses() the stream. The latter is ok unless you need to keep the stream open to continue communication, in which case you have to let the receiving end know how much data to expect, or it will block indefinitely if the max length of data is not sent. You need to pack() and prepend the length of the outgoing data stream in the first 4 bytes of the packet, as follows:
function send_pkt($stream, $my_data)
{
$len = strlen($my_data);
$send_data = pack('N', $len) . $my_data; //Pack the length in a network-friendly way, then prepend it to the data.
$final_len = strlen($send_data);
if ( fwrite($stream, $send_data) < $final_len ) {
//something went wrong, trigger error
}
}
function recv_pkt($stream)
{
$packed_len = stream_get_contents($stream, 4); //The first 4 bytes contain our N-packed length
$hdr = unpack('Nlen', $packed_len);
$len = $hdr['len'];
$recvd_data = stream_get_contents($stream, $len);
return $recvd_data;
}
