PHP: socket_getpeername - Manual (original) (raw)
(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)
socket_getpeername — Queries the remote side of the given socket
Description
Parameters
socket
A Socket instance created with socket_create() or socket_accept().
address
If the given socket is of type [AF_INET](sockets.constants.php#constant.af-inet) or**[AF_INET6](sockets.constants.php#constant.af-inet6)**, socket_getpeername() will return the peers (remote) IP address in appropriate notation (e.g. 127.0.0.1 orfe80::1) in the address parameter and, if the optional port parameter is present, also the associated port.
If the given socket is of type [AF_UNIX](sockets.constants.php#constant.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 toaddress.
Return Values
Returns [true](reserved.constants.php#constant.true) on success or [false](reserved.constants.php#constant.false) on failure. socket_getpeername() may also return**[false](reserved.constants.php#constant.false)** if the socket type is not any of [AF_INET](sockets.constants.php#constant.af-inet),[AF_INET6](sockets.constants.php#constant.af-inet6), or [AF_UNIX](sockets.constants.php#constant.af-unix), in which case the last socket error code is not updated.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | socket is a Socket instance now; previously, it was a resource. |
Notes
Note:
socket_getpeername() should not be used with**
[AF_UNIX](sockets.constants.php#constant.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
Found A Problem?
redph0enix at hotmail dot com ¶
22 years ago
socket_getpeername will not work for UDP sockets. Instead, use socket_recvfrom - it provides the IP address and port of the source server - eg:
<span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>s</mi><mi>i</mi><mi>z</mi><mi>e</mi><mo>=</mo><mi>s</mi><mi>o</mi><mi>c</mi><mi>k</mi><mi>e</mi><msub><mi>t</mi><mi>r</mi></msub><mi>e</mi><mi>c</mi><mi>v</mi><mi>f</mi><mi>r</mi><mi>o</mi><mi>m</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">size=socket_recvfrom(</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6595em;"></span><span class="mord mathnormal">s</span><span class="mord mathnormal">i</span><span class="mord mathnormal">ze</span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2778em;"></span></span><span class="base"><span class="strut" style="height:1em;vertical-align:-0.25em;"></span><span class="mord mathnormal">soc</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord"><span class="mord mathnormal">t</span><span class="msupsub"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.1514em;"><span style="top:-2.55em;margin-left:0em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathnormal mtight" style="margin-right:0.02778em;">r</span></span></span></span><span class="vlist-s"></span></span><span class="vlist-r"><span class="vlist" style="height:0.15em;"><span></span></span></span></span></span></span><span class="mord mathnormal">ec</span><span class="mord mathnormal" style="margin-right:0.03588em;">v</span><span class="mord mathnormal" style="margin-right:0.10764em;">f</span><span class="mord mathnormal">ro</span><span class="mord mathnormal">m</span><span class="mopen">(</span></span></span></span>socket,$input,65535,0,$ipaddress,$port);
echo "Received [$input] ($size bytes) from IP <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>i</mi><mi>p</mi><mi>a</mi><mi>d</mi><mi>d</mi><mi>r</mi><mi>e</mi><mi>s</mi><mi>s</mi><mi>P</mi><mi>o</mi><mi>r</mi><mi>t</mi></mrow><annotation encoding="application/x-tex">ipaddress Port </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord mathnormal">i</span><span class="mord mathnormal">p</span><span class="mord mathnormal">a</span><span class="mord mathnormal">dd</span><span class="mord mathnormal">ress</span><span class="mord mathnormal" style="margin-right:0.13889em;">P</span><span class="mord mathnormal" style="margin-right:0.02778em;">or</span><span class="mord mathnormal">t</span></span></span></span>port\n";9 years ago
The reason it won't work for UDP is that UDP is stateless; logically there are no peers other than at the time a packet is sent or received. Or more strictly, a UDP socket can interact with 0..N peers.