socket-getpeername.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5eaa3458d57434d0ce08207726a7d25df2994c6d Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.socket-getpeername" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_getpeername</refname>
  <refpurpose>Interroge l'autre extrémité de la communication</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>
   Interroge l'autre extrémité de la communication.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Une instance de <classname>Socket</classname> créée par
       <function>socket_create</function> ou <function>socket_accept</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       Si le socket <parameter>socket</parameter> est de type
       <constant>AF_INET</constant>, ou <constant>AF_INET6</constant>
       <function>socket_getpeername</function> retournera
       <emphasis>l'adresse IP</emphasis> de l'hôte, en notation numérique (e.g.
       <literal>127.0.0.1</literal> ou <literal>fe80::1</literal>) dans le
       paramètre <parameter>address</parameter>, et si le paramètre optionnel
       <parameter>port</parameter> est présent, elle retournera aussi le port
       de la communication établie.
      </para>
      <para>
       Si le socket <parameter>socket</parameter> est de type <constant>AF_UNIX</constant>,
       <function>socket_getpeername</function> retournera le chemin sur le
       système de fichiers (e.g. <literal>/var/run/daemon.sock</literal>) dans le 
       paramètre <parameter>address</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Si fourni, ce devra être le port associé à l'adresse
       du paramètre <parameter>address</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success; <function>socket_getpeername</function> peut aussi
   retourner &false; si le type de le socket n'est ni <constant>AF_INET</constant>
   <constant>AF_INET6</constant>, ni <constant>AF_UNIX</constant>, auquel cas le
   dernier code d'erreur socket n'est <emphasis>pas</emphasis> modifié.
  </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_getsockname</function> ne doit pas être utilisée avec les sockets
    <constant>AF_UNIX</constant> créés avec <function>socket_accept</function>.
    Seules les sockets créées avec <function>socket_connect</function> ou une socket
    serveur primaire suivant un appel à <function>socket_bind</function> retourneront
    des valeurs logiques.
   </para>
  </note>
  <note>
   <para>
    Pour faire en sorte que la fonction
    <function>socket_getpeername</function> retourne une
    valeur cohérente, le socket sur lequel la fonction est
    appelée doit évidemment être un pour qui le conscepte
    de "peer" a du sens.
   </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
-->