socket_getpeername
(PHP 4 >= 4.1.0, PHP 5, PHP 7)
socket_getpeername — Queries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type
Description
$socket
, string &$address
[, int &$port
] ) : boolQueries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type.
Parameters
-
socket
-
A valid socket resource created with socket_create() or socket_accept().
-
address
-
If the given socket is of type
AF_INET
orAF_INET6
, socket_getpeername() will return the peers (remote) IP address in appropriate notation (e.g. 127.0.0.1 or fe80::1) in theaddress
parameter and, if the optionalport
parameter is present, also the associated port.If the given socket is of type
AF_UNIX
, socket_getpeername() will return the Unix filesystem path (e.g. /var/run/daemon.sock) in theaddress
parameter. -
port
-
If given, this will hold the port associated to
address
.
Return Values
Returns TRUE
on success or FALSE
on failure. socket_getpeername() 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.
Notes
Note:
socket_getpeername() should not be used with
AF_UNIX
sockets created with socket_accept(). Only sockets created with socket_connect() or a primary server socket following a call to socket_bind() will return meaningful values.
Note:
For having socket_getpeername() to return a meaningful value, the socket it is applied upon must of course be one for which the concept of "peer" makes sense.
See Also
- 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_last_error() - Returns the last error on the socket
- socket_strerror() - Return a string describing a socket error
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.socket-getpeername.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.