socket-getsockname.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.socket-getsockname" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_getsockname</refname>
  <refpurpose>Запрашивает локальную сторону указанного сокета, в результате можно получить хост/порт или путь в файловой системе Unix, в зависимости от типа сокета</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>socket_getsockname</methodname>
   <methodparam><type>Socket</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><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <note>
   <simpara>
    Функция <function>socket_getsockname</function> не должна использоваться с
    сокетами <constant>AF_UNIX</constant>, созданными при помощи функции <function>socket_connect</function>.
    Только сокеты, созданные функцией <function>socket_accept</function> и первичные
    серверные сокеты после вызова <function>socket_bind</function>, позволяют получить
    осмысленный ответ при вызове этой функции.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Экземпляр <classname>Socket</classname>, созданный функцией <function>socket_create</function>
       или <function>socket_accept</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       Если заданный сокет имеет тип <constant>AF_INET</constant> или
       <constant>AF_INET6</constant>, <function>socket_getpeername</function>
       вернёт локальный <emphasis>IP-адрес</emphasis> в соответствующем формате (
       например, <literal>127.0.0.1</literal> или <literal>fe80::1</literal>) в параметре
       <parameter>address</parameter> и, если необязательный параметр
       <parameter>port</parameter> присутствует, также связанный порт.
      </para>
      <para>
       Если заданный сокет имеет тип <constant>AF_UNIX</constant>,
       <function>socket_getpeername</function> вернёт путь в файловой системе Unix
       (т.е. <literal>/var/run/daemon.sock</literal>) в параметр
       <parameter>address</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Если указан, то будет содержать соответствующий порт.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success; <function>socket_getsockname</function> может также возвращать
   &false;, если тип сокета не является одним из <constant>AF_INET</constant>,
   <constant>AF_INET6</constant>, или <constant>AF_UNIX</constant>, в этом случае
   код последней ошибки сокета <emphasis>не</emphasis> обновляется.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &sockets.changelog.socket-param;
     </tbody>
    </tgroup>
   </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_getpeername</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
-->