Files
doc-fr/reference/sockets/functions/socket-getsockname.xml
T
Yannick Torres cedcf2fa81 syn with EN
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@260584 c90b9560-bf6c-de11-be94-00142212c4b1
2008-06-01 22:14:44 +00:00

119 lines
3.9 KiB
XML
Executable File

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- EN-Revision: 1.12 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-getsockname">
<refnamediv>
<refname>socket_getsockname</refname>
<refpurpose>Interroge la socket locale</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>socket_getsockname</methodname>
<methodparam><type>resource</type><parameter>socket</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">addr</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">port</parameter></methodparam>
</methodsynopsis>
<note>
<simpara>
<function>socket_getsockname</function> ne doit pas être utilisée avec les sockets
<constant>AF_UNIX</constant> créées avec <function>socket_connect</function>.
Seules les sockets suivant un appel de <function>socket_bind</function> retourneront
des valeurs logiques.
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
Une ressource de socket valide, créée par la fonction
<function>socket_create</function> ou la fonction
<function>socket_accept</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>addr</parameter></term>
<listitem>
<para>
Si la socket <parameter>socket</parameter> est de type <constant>AF_INET</constant>,
ou <constant>AF_INET6</constant>, <function>socket_getsockname</function> retournera
<emphasis>l'adresse IP</emphasis> locale, 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 la socket <parameter>socket</parameter> est de type <constant>AF_UNIX</constant>,
<function>socket_getsockname</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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; <function>socket_getsockname</function> peut aussi
retourner &false; si le type de la socket n'est ni <constant>AF_INET</constant>,
ni <constant>AF_INET</constant>, ni <constant>AF_UNIX</constant>, auquel cas
le dernier code d'erreur socket n'est <emphasis>pas</emphasis> modifié.
</para>
</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:"../../../../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
-->