socket-getpeername.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5eaa3458d57434d0ce08207726a7d25df2994c6d Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.socket-getpeername" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_getpeername</refname>
  <refpurpose>指定したソケットのリモート側に問い合わせる</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>socket_getpeername</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>
  <para>
   指定したソケットのリモート側に問い合わせ、
   その型に応じてホスト/ポート、あるいは
   Unix ファイルシステムのパスを返します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       <function>socket_create</function> あるいは <function>socket_accept</function>
       で作成した <classname>Socket</classname> クラスのインスタンス。
      </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>
       指定した場合は、
       <parameter>address</parameter> に関連付けるポートを保持します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success; <function>socket_getpeername</function> は、
   ソケットの型が <constant>AF_INET</constant>、
   <constant>AF_INET6</constant> あるいは <constant>AF_UNIX</constant>
   のいずれでもない場合にも &false; を返します。この場合には、
   直近のソケットエラーコードは更新<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="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>socket_getpeername</function> は、
    <function>socket_accept</function> で作成した <constant>AF_UNIX</constant>
    ソケットとともに使用することはできません。意味のある値が返されるのは、
    <function>socket_connect</function> で作成したソケットか
    <function>socket_bind</function> に続くプライマリサーバーソケットのみです。
   </para>
  </note>
  <note>
   <para>
    <function>socket_getpeername</function> に何らかの意味のある値を返させるには、
    もちろんソケット自体が "peer" の概念を満たしている必要があります。
   </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
-->