socket_read
(PHP 4 >= 4.1.0, PHP 5, PHP 7)
socket_read — Reads a maximum of length bytes from a socket
Description
$socket
, int $length
[, int $type
= PHP_BINARY_READ
] ) : string
The function socket_read() reads from the socket
resource socket
created by the
socket_create() or
socket_accept() functions.
Parameters
-
socket
-
A valid socket resource 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 thetype
parameter, see below). -
type
-
Optional
type
parameter is a named constant:-
PHP_BINARY_READ
(Default) - use the system recv() function. Safe for reading binary data. -
PHP_NORMAL_READ
- reading stops at \n or \r.
-
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.
See Also
- socket_accept() - Accepts a connection on a socket
- socket_bind() - Binds a name to a socket
- socket_connect() - Initiates a connection on a socket
- socket_listen() - Listens for a connection on a socket
- socket_last_error() - Returns the last error on the socket
- socket_strerror() - Return a string describing a socket error
- socket_write() - Write to a socket
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-socket-read.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.