archived-doc-es/reference/sockets/functions/socket-recvfrom.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: seros Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-recvfrom">
 <refnamediv>
  <refname>socket_recvfrom</refname>
  <refpurpose>Recibe información desde un socket que esté o no orientado a conexión</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>socket_recvfrom</methodname>
   <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">buf</parameter></methodparam>
   <methodparam><type>int</type><parameter>len</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">name</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">port</parameter></methodparam>
  </methodsynopsis>
  <para>
   La función <function>socket_recvfrom</function> recibe
   <parameter>len</parameter> bytes de información en <parameter>buf</parameter> desde
   <parameter>name</parameter> en el puerto <parameter>port</parameter> (si el
   socket no es del tipo <constant>AF_UNIX</constant>) usando
   <parameter>socket</parameter>. <function>socket_recvfrom</function> se puede
   usar para reunir información tanto desde socket conectados como de no conectados.
   Además, se pueden especificar una o más banderas para modificar el comportamiento de
   la función.
  </para>
  <para>
   <parameter>name</parameter> y <parameter>port</parameter> deben ser
   pasados por referencia. Si el socket no está orientado a conexión,
   <parameter>name</parameter> será establecido a la dirección del protocolo de internet del
   host remoto o a la ruta del socket UNIX. Si el socket está
   orientado a conxión, <parameter>name</parameter> es &null;. Además,
   <parameter>port</parameter> contendrá el puerto del host remoto en
   el caso de un socket <constant>AF_INET</constant> o
   <constant>AF_INET6</constant> no conectado.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       <parameter>socket</parameter> debe ser un recurso socket previamente
       creado por socket_create().
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>buf</parameter></term>
     <listitem>
      <para>
       La información recibida será recuperada a la variable especificada por
       <parameter>buf</parameter>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>len</parameter></term>
     <listitem>
      <para>
       Se obtendrán hasta <parameter>len</parameter> bytes desde el host remoto.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       El valor de <parameter>flags</parameter> puede ser una combinación de
       las siguientes banderas, unidas con el operador binario OR
       (<literal>|</literal>).
      </para>
      
      <table>
       <title>Valores posibles de <parameter>flags</parameter></title>
       <tgroup cols="2">
        <thead>
         <row>
          <entry>Bandera</entry>
          <entry>Descripción</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry><constant>MSG_OOB</constant></entry>
          <entry>
           Procesar información fuera de banda.
          </entry>
         </row>
         <row>
          <entry><constant>MSG_PEEK</constant></entry>
          <entry>
           Recibir informaicón desde el inicio de la cola recibida sin
           eliminarla de la cola.
          </entry>
         </row>
         <row>
          <entry><constant>MSG_WAITALL</constant></entry>
          <entry>
           Bloquea hasta que al menos se reciba <parameter>len</parameter> bytes.
           Sin embargo, si se captura una señal o el host remoto se desconecta, la
           función puede devolver menos información.
          </entry>
         </row>
         <row>
          <entry><constant>MSG_DONTWAIT</constant></entry>
          <entry>
           Con esta bandera establecida, la función devuelve incluso si normalmente
           habría bloqueado.
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Si el socket es de tipo <constant>AF_UNIX</constant>,
       <parameter>name</parameter> es la ruta del archivo. Por lo demás, para
       sockets no conectados, <parameter>name</parameter> es la dirección IP del
       host remoto, o &null; si el socket está orientado a conexion.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Este argumento sólo se aplica a sockets <constant>AF_INET</constant> y
       <constant>AF_INET6</constant>, y especifica el puerto remoto
       desde el que la información es recibida. Si el socket está orientado a conexión,
       <parameter>port</parameter> será &null;.
      </para>
     </listitem>
    </varlistentry>
    
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_recvfrom</function> devuelve el número de bytes recibidos,
   o &false; si hubo un error. El código de error real se puede recuperar
   llamando a <function>socket_last_error</function>. Este código de error se puede
   pasar a <function>socket_strerror</function> para obtener una explicación textual
   del error.
  </para>
 </refsect1>
                     
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Un ejemplo de <function>socket_recvfrom</function></title>
    <programlisting role="php">
<![CDATA[
<?php
error_reporting(E_ALL | E_STRICT);

$socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
socket_bind($socket, '127.0.0.1', 1223);

$from = '';
$port = 0;
socket_recvfrom($socket, $buf, 12, 0, $from, $port);

echo "Se recibió $buf desde la dirección remota $from y el puerto remoto $port" . PHP_EOL;
?>
]]>
    </programlisting>
    <para>
     Este ejemplo iniciará un socket UDP en el puerto 1223 de 127.0.0.1
     e imprimirá al menos 12 caracteres recibidos desde un host remoto.
    </para>
   </example>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.3.0</entry>
       <entry>
        <function>socket_recvfrom</function> ahora es segura a nivel binario.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

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