socket_get_option

Gets socket options for the socket.

socket_get_option Function synopsis

socket_get_option(
    Socket $socket,
    int $level,
    int $option
  ): array|int|false

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 retrieve 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

Reports whether the $socket lingers on socket_close if data is present. By default, when the socket is closed, it attempts to send all unsent data. In the case of a connection-oriented socket, socket_close will wait for its peer to acknowledge the data.

Return value

Typearray|int|false

Returns the value of the given option, or false on failure.