socket_recvfrom

Receives data from a socket whether or not it is connection-oriented.

socket_recvfrom Function synopsis

socket_recvfrom(
    Socket $socket,
    &$data,
    int $length,
    int $flags,
    &$address,
    &$port = null
  ): 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.

$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

$address

Passed by reference

If the socket is of the type AF_UNIX type, $address is the path to the file. Else, for unconnected sockets, $address is the IP address of, the remote host, or null if the socket is connection-oriented.

$port

Passed by reference, OptionalDefault valuenull

This argument only applies to AF_INET and AF_INET6 sockets, and specifies the remote port from which the data is received. If the socket is connection-oriented, $port will be null.

Note that the parameters $data, $address, and $port are passed by reference, and contain additional/updated context data that may be useful.

Return value

Typeint|false

socket_recvfrom 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.