<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.stream.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.stream-socket-recvfrom.php',
    1 => 'stream_socket_recvfrom',
    2 => 'Recebe dados de um socket, conectado ou n&atilde;o',
  ),
  'up' => 
  array (
    0 => 'ref.stream.php',
    1 => 'Fun&ccedil;&otilde;es de Fluxo',
  ),
  'prev' => 
  array (
    0 => 'function.stream-socket-pair.php',
    1 => 'stream_socket_pair',
  ),
  'next' => 
  array (
    0 => 'function.stream-socket-sendto.php',
    1 => 'stream_socket_sendto',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/stream/functions/stream-socket-recvfrom.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.stream-socket-recvfrom" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">stream_socket_recvfrom</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">stream_socket_recvfrom</span> &mdash; <span class="dc-title">Recebe dados de um socket, conectado ou não</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.stream-socket-recvfrom-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>stream_socket_recvfrom</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$socket</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter reference">&$address</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>stream_socket_recvfrom()</strong></span> aceita
   dados de um socket remoto até a quantidade de bytes definida por <code class="parameter">length</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.stream-socket-recvfrom-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">socket</code></dt>
     <dd>
      <p class="para">
       O socket remoto.
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       O número de bytes a receber do <code class="parameter">socket</code>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       O valor de <code class="parameter">flags</code> pode ser qualquer combinação
       das opções a seguir:
       <table class="doctable table">
        <caption><strong>Valores possíveis para <code class="parameter">flags</code></strong></caption>
        
         <tbody class="tbody">
          <tr>
           <td><strong><code><a href="stream.constants.php#constant.stream-oob">STREAM_OOB</a></code></strong></td>
           <td>
            Processa dados fora-de-banda (do inglês OOB <code class="literal">out-of-band</code>).
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="stream.constants.php#constant.stream-peek">STREAM_PEEK</a></code></strong></td>
           <td>
            Recebe dados do socket, mas não consome o buffer.
            Chamadas subsequentes a <span class="function"><a href="function.fread.php" class="function">fread()</a></span> ou
            <span class="function"><strong>stream_socket_recvfrom()</strong></span> irão ver
            os mesmos dados.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>
     </dd>
    
    
     <dt><code class="parameter">address</code></dt>
     <dd>
      <p class="para">
       Se <code class="parameter">address</code> for fornecido, será preenchido com
       o endereço do socket remoto.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.stream-socket-recvfrom-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna os dados lidos, como uma string, ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.stream-socket-recvfrom-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>stream_socket_recvfrom()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">/* Abre um socket de servidor na porta 1234 no servidor local */<br /></span><span style="color: #0000BB">$server </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_socket_server</span><span style="color: #007700">(</span><span style="color: #DD0000">'tcp://127.0.0.1:1234'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Aceita uma conexão */<br /></span><span style="color: #0000BB">$socket </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_socket_accept</span><span style="color: #007700">(</span><span style="color: #0000BB">$server</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Pega um pacote (1500 é um tamanho típico de MTU) de dados OOB */<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Recebido Out-Of-Band: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">stream_socket_recvfrom</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">1500</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_OOB</span><span style="color: #007700">) . </span><span style="color: #DD0000">"'\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Dá uma olhada nos dados normais dentro-da-banda, mas não os consome. */<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Dados: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">stream_socket_recvfrom</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">1500</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_PEEK</span><span style="color: #007700">) . </span><span style="color: #DD0000">"'\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Obtém o mesmo pacote novamente, mas remove-o do buffer desta vez. */<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Dados: '" </span><span style="color: #007700">. </span><span style="color: #0000BB">stream_socket_recvfrom</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">1500</span><span style="color: #007700">) . </span><span style="color: #DD0000">"'\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Fecha tudo */<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$socket</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$server</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.stream-socket-recvfrom-notes">
  <h3 class="title">Notas</h3>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    Se uma mensagem recebida for maior que o parâmetro <code class="parameter">length</code>,
    os bytes excedentes podem ser descartados dependendo do tipo do socket
    do qual a mensagem for recebida (como no UDP).
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    Chamadas a <span class="function"><strong>stream_socket_recvfrom()</strong></span> em fluxos baseados
    em socket, depois de chamadas a funções de fluxo baseadas em buffer (como
    <span class="function"><a href="function.fread.php" class="function">fread()</a></span> ou <span class="function"><a href="function.stream-get-line.php" class="function">stream_get_line()</a></span>) lêem
    dados diretamente do socket e ignoram o buffer de fluxo.
    </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.stream-socket-recvfrom-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.stream-socket-sendto.php" class="function" rel="rdfs-seeAlso">stream_socket_sendto()</a> - Envia uma mensagem a um socket, conectado ou n&atilde;o</span></li>
   <li><span class="function"><a href="function.stream-socket-client.php" class="function" rel="rdfs-seeAlso">stream_socket_client()</a> - Abre conex&atilde;o de socket de dom&iacute;nio Internet ou Unix</span></li>
   <li><span class="function"><a href="function.stream-socket-server.php" class="function" rel="rdfs-seeAlso">stream_socket_server()</a> - Cria socket de servidor de dom&iacute;nio Internet ou Unix</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>