socket_recv

Receives data from a connected socket.

socket_recv Function synopsis

socket_recv(
    Socket $socket,
    &$data,
    int $length,
    int $flags
  ): int|false

Parameters

$socket

TypeSocket

The $socket must be a Socket instance previously created by socket_create.

$data

Passed by reference

The data received will be fetched to the variable specified with $data. If an error occurs, if the connection is reset, or if no data is available, $data will be set to null.

$length

Typeint

Up to $length bytes will be fetched from remote host.

$flags

Typeint

The value of $flags can be any combination of the following flags, joined with the binary OR (|) operator.

$flags accepts one or a bitmask of the following constant values:

• MSG_OOB
• MSG_PEEK
• MSG_WAITALL
• MSG_DONTWAIT

Note that the parameter $data is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typeint|false

socket_recv returns the number of bytes received, or false if there was an error. The actual error code can be retrieved by calling socket_last_error. This error code may be passed to socket_strerror to get a textual explanation of the error.