socket_set_option

Function • Params and return types changed in PHP 8.0

Sets socket options for the 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_set_option Function synopsis

socket_set_option(
    Socket $socket,
    int $level,
    int $option,
    $value
  ): bool

Parameters

$socket

TypeSocket

A Socket instance created with socket_create or socket_accept.

$level

Typeint

The $level parameter specifies the protocol level at which the option resides. For example, to set options at the socket level, a $level parameter of SOL_SOCKET would be used. Other levels, such as TCP, can be used by specifying the protocol number of that level. Protocol numbers can be found by using the getprotobyname function.

$option

Typeint

The available socket options are the same as those for the socket_get_option function.

$value

The option value.

Return value

Typebool

Returns true on success, false on failure

Changes to the socket_set_option Function

PHP 8.0

  • Return type added: bool
  • Parameter type added for parameter #1 ($socket): Socket
  • Parameter type added for parameter #2 ($level): int
  • Parameter name of parameter #3 changed: $optname to $option
  • Parameter type added for parameter #3 ($option): int
  • Parameter name of parameter #4 changed: $optval to $value
  socket_set_option(
-     $socket,
+     Socket $socket,
-     $level,
+     int $level,
-     $optname,
+     int $option,
-     $optval
+     $value
-   )
+   ): bool

socket_set_option 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