socket_getsockname
(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)
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
Description
socket_getsockname() should not be used with AF_UNIX sockets created with socket_connect(). Only sockets created with socket_accept() or a primary server socket following a call to socket_bind() will return meaningful values.
Parameters
socketA
Socketinstance created withsocket_create()orsocket_accept().addressIf the given socket is of type
AF_INETorAF_INET6,socket_getsockname()will return the local IP address in appropriate notation (e.g.127.0.0.1orfe80::1) in theaddressparameter and, if the optionalportparameter is present, also the associated port.If the given socket is of type
AF_UNIX,socket_getsockname()will return the Unix filesystem path (e.g./var/run/daemon.sock) in theaddressparameter.portIf provided, this will hold the associated port.
Return Values
Success 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.
Changelog
| Version | Description |
|---|---|
| 8.5.0 | Now retrieves the interface index and its string representation when used on an AF_PACKET family socket. |