mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
91e836093c
as UNIX is a registered trademark by the Open Group. References to UNIX were left in where it made sense, like example outputs, and so forth. You can read the Trademark User Guide for "UNIX" at: http://www.unix.org/tmug2.ps or http://www.unix.org/tmug2.pdf git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@147067 c90b9560-bf6c-de11-be94-00142212c4b1
78 lines
3 KiB
XML
78 lines
3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.27 -->
|
|
<refentry id="function.socket-getsockname">
|
|
<refnamediv>
|
|
<refname>socket_getsockname</refname>
|
|
<refpurpose>
|
|
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.
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>socket_getsockname</methodname>
|
|
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>&addr</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>&port</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
If the given socket is of type <constant>AF_INET</constant>
|
|
or <constant>AF_INET6</constant>, <function>socket_getsockname</function>
|
|
will return the local <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_getsockname</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_getsockname</function> should not be used with
|
|
<constant>AF_UNIX</constant> sockets created with <function>socket_connect</function>.
|
|
Only sockets created with <function>socket_accept</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_getsockname</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_getpeername</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
|
|
-->
|