socket_getsockname

Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type.

socket_getsockname Function synopsis

socket_getsockname(
    Socket $socket,
    &$address,
    &$port = null
  ): bool

Parameters

$socket

TypeSocket

A Socket instance created with socket_create or socket_accept.

$address

Passed by reference

If the given socket is of type AF_INET or AF_INET6, socket_getsockname will return the local IP address in appropriate notation (e.g. 127.0.0.1 or fe80::1) in the $address parameter and, if the optional $port parameter is present, also the associated port.

$port

Passed by reference, OptionalDefault valuenull

If provided, this will hold the associated port.

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

Return value

Typebool

Returns true on success, false on failure socket_getsockname may also return false if the socket type is not any of AF_INET, AF_INET6, or AF_UNIX, in which case the last socket error code is not updated.