archived-doc-pt-br/reference/sockets/functions/socket-getpeername.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5eaa3458d57434d0ce08207726a7d25df2994c6d Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.socket-getpeername" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_getpeername</refname>
  <refpurpose>Consulta o lado remoto do soquete fornecido</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>
   Consulta o lado remoto de um determinado soquete, o que pode resultar em
   servidor/porta ou em um caminho do sistema de arquivos Unix, dependendo do seu tipo.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Uma instância de <classname>Socket</classname> criada com <function>socket_create</function>
       ou <function>socket_accept</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       Se o soquete fornecido for do tipo <constant>AF_INET</constant> ou
       <constant>AF_INET6</constant>, <function>socket_getpeername</function>
       retornará o <emphasis>endereço IP</emphasis> dos pares (remotos) em
       notação apropriada (por exemplo, <literal>127.0.0.1</literal> ou
       <literal>fe80::1</literal>) no parâmetro <parameter>address</parameter>
       e, se o parâmetro opcional <parameter>port</parameter> estiver
       presente, retornará também a porta associada.
      </para>
      <para>
       Se o soquete fornecido for do tipo <constant>AF_UNIX</constant>,
       <function>socket_getpeername</function> retornará o caminho do sistema
       de arquivos Unix (por exemplo, <literal>/var/run/daemon.sock</literal>) no
       parâmetro <parameter>address</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Se fornecida, esta variável conterá a porta associada ao
       endereço informado em <parameter>address</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success; <function>socket_getpeername</function> pode também retornar
   &false; se o tipo de soquete não for <constant>AF_INET</constant>,
   <constant>AF_INET6</constant> ou <constant>AF_UNIX</constant>. Neste
   caso, o último código de erro de soquete <emphasis>NÃO É</emphasis> atualizado.
  </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> não deve ser usada com
    soquetes <constant>AF_UNIX</constant> criados com <function>socket_accept</function>.
    Somente soquetes criados com <function>socket_connect</function> ou um soquete
    de servidor primário após uma chamada a <function>socket_bind</function> retornarão
    valores significativos.
   </para>
  </note>
  <note>
   <para>
    Para que <function>socket_getpeername</function> retorne um valor significativo,
    o soquete ao qual ele é aplicado deve, obviamente, ser aquele para o qual o conceito de
    "par" faça sentido.
   </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
-->