Home/ Manual/ sockets / functions/ socket_create_listen

socket_create_listen

PHP function Edit on GitHub ✎

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

Opens a socket on port to accept connections

Description

socket_create_listen(int $port, int $backlog = SOMAXCONN): Socket|false

socket_create_listen() creates a new Socket instance of type AF_INET listening on all local interfaces on the given port waiting for new connections.

This function is meant to ease the task of creating a new socket which only listens to accept new connections.

Parameters

port: The port on which to listen on all interfaces.
backlog: The backlog parameter defines the maximum length the queue of pending connections may grow to. SOMAXCONN may be passed as backlog parameter, see socket_listen() for more information.

Return Values

socket_create_listen() returns a new Socket instance on success or false on error. 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.

Changelog

Version	Description
8.5.0	Now throws a `ValueError` when `port` is lower than 0 or greater than 65535.
8.4.0	The default value of `backlog` is now `SOMAXCONN`. Previously it was `128`.
8.0.0	On success, this function returns a `Socket` instance now; previously, a `resource` was returned.

Notes

Note

If you want to create a socket which only listens on a certain interface you need to use socket_create(), socket_bind() and socket_listen().