array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.socket-read.php', 1 => 'socket_read', 2 => 'Reads a maximum of length bytes from a socket', ), 'up' => array ( 0 => 'ref.sockets.php', 1 => 'Socket Functions', ), 'prev' => array ( 0 => 'function.socket-listen.php', 1 => 'socket_listen', ), 'next' => array ( 0 => 'function.socket-recv.php', 1 => 'socket_recv', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/sockets/functions/socket-read.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

socket_read

(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

socket_read — Reads a maximum of length bytes from a socket

Description

socket_read(Socket $socket, int $length, int $mode = PHP_BINARY_READ): string|false

The function socket_read() reads from the Socket instance socket created by the socket_create() or socket_accept() functions.

Parameters

socket

A Socket instance created with socket_create() or socket_accept().

length

The maximum number of bytes read is specified by the length parameter. Otherwise you can use \r, \n, or \0 to end reading (depending on the mode parameter, see below).

mode

Optional mode parameter is a named constant:

Return Values

socket_read() returns the data as a string on success, or false on error (including if the remote host has closed the connection). The error code can be retrieved with socket_last_error(). This code may be passed to socket_strerror() to get a textual representation of the error.

Note:

socket_read() returns a zero length string ("") when there is no more data to read.

Changelog

Version Description
8.0.0 socket is a Socket instance now; previously, it was a resource.

See Also