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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml: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 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>socket_getpeername</methodname>
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">address</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">port</parameter></methodparam>
</methodsynopsis>
<para>
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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
A valid socket resource created with <function>socket_create</function>
or <function>socket_accept</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>address</parameter></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
If given, this will hold the port associated to
<parameter>address</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<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.
</para>
</note>
<note>
<para>
For having <function>socket_getpeername</function> to return a meaningful value,
the socket it is applied upon must of course be one for which the concept of
"peer" makes sense.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>socket_getsockname</function></member>
<member><function>socket_last_error</function></member>
<member><function>socket_strerror</function></member>
</simplelist>
</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:"~/.phpdoc/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
-->
|
