socket_listen

FunctionParams and return types changed in PHP 8.0

Listens for a connection on a socket.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

socket_listen Function synopsis

socket_listen(Socket $socket, int $backlog = 0): bool

Parameters

$socket

TypeSocket

A Socket instance created with socket_create or socket_addrinfo_bind

$backlog

OptionalTypeintDefault value0

A maximum of $backlog incoming 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.

Return value

Typebool

Returns true on success, 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.

Changes to the socket_listen Function

PHP 8.0

  • Return type added: bool
  • Parameter type added for parameter #1 ($socket): Socket
  • Parameter type added for parameter #2 ($backlog): int
  • Parameter default value added for position #2 ($backlog): 0
- socket_listen($socket, $backlog)
+ socket_listen(Socket $socket, int $backlog = 0): bool

socket_listen Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes