1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.27 -->
<refentry id="function.socket-getpeername">
<refnamediv>
<refname>socket_getpeername</refname>
<refpurpose>
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
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>socket_getpeername</methodname>
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">addr</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">port</parameter></methodparam>
</methodsynopsis>
<para>
If the given socket is of type <constant>AF_INET</constant>
or <constant>AF_INET6</constant>, <function>socket_getpeername</function>
will return the peers (remote) <emphasis>IP address</emphasis> in appropriate notation (e.g.
<literal>127.0.0.1</literal> or <literal>fe80::1</literal>) in the
<parameter>address</parameter> parameter and, if the optional
<parameter>port</parameter> parameter is present, also the associated port.
</para>
<para>
If the given socket is of type <constant>AF_UNIX</constant>,
<function>socket_getpeername</function> will return the Unix filesystem
path (e.g. <literal>/var/run/daemon.sock</literal>) in the
<parameter>address</parameter> parameter.
</para>
<note>
<simpara>
<function>socket_getpeername</function> should not be used with
<constant>AF_UNIX</constant> sockets created with <function>socket_accept</function>.
Only sockets created with <function>socket_connect</function> or a primary
server socket following a call to <function>socket_bind</function> will return
meaningful values.
</simpara>
</note>
<para>
&return.success; <function>socket_getpeername</function> may also return
&false; if the socket type is not any of <constant>AF_INET</constant>,
<constant>AF_INET6</constant>, or <constant>AF_UNIX</constant>, in which
case the last socket error code is <emphasis>not</emphasis> updated.
</para>
<para>
See also
<function>socket_getsockname</function>,
<function>socket_last_error</function> and
<function>socket_strerror</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
