socket_listen
(PHP 4 >= 4.1.0, PHP 5, PHP 7)
socket_listen — Listens for a connection on a socket
Description
$socket
[, int $backlog = 0
] ) : bool
After the socket socket has been created
using socket_create() and bound to a name with
socket_bind(), it may be told to listen for incoming
connections on socket.
socket_listen() is applicable only to sockets of
type SOCK_STREAM or
SOCK_SEQPACKET.
Parameters
-
socket -
A valid socket resource created with socket_create() or socket_addrinfo_bind()
-
backlog -
A maximum of
backlogincoming connections will be queued for processing. If a connection request arrives with the queue full the client may receive an error with an indication of ECONNREFUSED, or, if the underlying protocol supports retransmission, the request may be ignored so that retries may succeed.Note:
The maximum number passed to the
backlogparameter highly depends on the underlying platform. On Linux, it is silently truncated toSOMAXCONN. On win32, if passedSOMAXCONN, the underlying service provider responsible for the socket will set the backlog to a maximum reasonable value. There is no standard provision to find out the actual backlog value on this platform.
Return Values
Returns TRUE on success or FALSE on failure. The error code can be retrieved with
socket_last_error(). This code may be passed to
socket_strerror() to get a textual explanation of the
error.
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_create() - Create a socket (endpoint for communication)
- socket_strerror() - Return a string describing a socket error
- socket_addrinfo_bind() - Create and bind to a socket from a given addrinfo
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-listen.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.
