<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sockets.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.socket-read.php',
    1 => 'socket_read',
    2 => 'L&ecirc; um m&aacute;ximo de bytes de um soquete',
  ),
  'up' => 
  array (
    0 => 'ref.sockets.php',
    1 => 'Fun&ccedil;&otilde;es de Socket',
  ),
  'prev' => 
  array (
    0 => 'function.socket-listen.php',
    1 => 'socket_listen',
  ),
  'next' => 
  array (
    0 => 'function.socket-recv.php',
    1 => 'socket_recv',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/sockets/functions/socket-read.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.socket-read" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">socket_read</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">socket_read</span> &mdash; <span class="dc-title">Lê um máximo de bytes de um soquete</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.socket-read-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>socket_read</strong></span>(<span class="methodparam"><span class="type"><a href="class.socket.php" class="type Socket">Socket</a></span> <code class="parameter">$socket</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$mode</code><span class="initializer"> = <strong><code><a href="sockets.constants.php#constant.php-binary-read">PHP_BINARY_READ</a></code></strong></span></span>): <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">
   A função <span class="function"><strong>socket_read()</strong></span> lê da instância <span class="classname"><a href="class.socket.php" class="classname">Socket</a></span>,
   o <code class="parameter">socket</code> criado pelas funções
   <span class="function"><a href="function.socket-create.php" class="function">socket_create()</a></span> ou
   <span class="function"><a href="function.socket-accept.php" class="function">socket_accept()</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.socket-read-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">socket</code></dt>
     <dd>
      <p class="para">
       Uma instância de <span class="classname"><a href="class.socket.php" class="classname">Socket</a></span> criada com <span class="function"><a href="function.socket-create.php" class="function">socket_create()</a></span>
       ou <span class="function"><a href="function.socket-accept.php" class="function">socket_accept()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       O número máximo de bytes lidos é especificado pelo
       parâmetro <code class="parameter">length</code>. De outra forma, podem ser usados os caracteres
       <code class="literal">\r</code>, <code class="literal">\n</code>,
       ou <code class="literal">\0</code> para encerrar a leitura (dependendo do parâmetro <code class="parameter">mode</code>,
       veja abaixo).
      </p>
     </dd>
    
    
     <dt><code class="parameter">mode</code></dt>
     <dd>
      <p class="para">
       O parâmetro opcional <code class="parameter">mode</code> é uma constante nomeada:
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="sockets.constants.php#constant.php-binary-read">PHP_BINARY_READ</a></code></strong> (Padrão) - usa a função de sistema
          <code class="literal">recv()</code>. Segura para ler dados binários.
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="sockets.constants.php#constant.php-normal-read">PHP_NORMAL_READ</a></code></strong> - a leitura é interrompida em
          <code class="literal">\n</code> ou <code class="literal">\r</code>.
         </span>
        </li>
       </ul>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.socket-read-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   <span class="function"><strong>socket_read()</strong></span> retorna os dados como uma string em caso de sucesso,
   ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de erro (inclusive se o servidor remoto tiver fechado a
   conexão). O código de erro pode ser recuperado com
   <span class="function"><a href="function.socket-last-error.php" class="function">socket_last_error()</a></span>. Este código pode ser passado para
   <span class="function"><a href="function.socket-strerror.php" class="function">socket_strerror()</a></span> para obter uma representação textual
   do erro.
  </p>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    <span class="function"><strong>socket_read()</strong></span> retorna uma string de comprimento zero (&quot;&quot;)
    quando não houver mais dados para leitura.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.socket-read-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
  <td>8.0.0</td>
  <td>
   O parâmetro <code class="parameter">socket</code> agora espera uma instância de <span class="classname"><a href="class.socket.php" class="classname">Socket</a></span>;
   anteriormente, um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> era esperado.
  </td>
 </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.socket-read-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.socket-accept.php" class="function" rel="rdfs-seeAlso">socket_accept()</a> - Aceita uma conex&atilde;o em um soquete</span></li>
    <li><span class="function"><a href="function.socket-bind.php" class="function" rel="rdfs-seeAlso">socket_bind()</a> - Vincula um nome a um soquete</span></li>
    <li><span class="function"><a href="function.socket-connect.php" class="function" rel="rdfs-seeAlso">socket_connect()</a> - Inicia uma conex&atilde;o em um soquete</span></li>
    <li><span class="function"><a href="function.socket-listen.php" class="function" rel="rdfs-seeAlso">socket_listen()</a> - Escuta uma conex&atilde;o em um soquete</span></li>
    <li><span class="function"><a href="function.socket-last-error.php" class="function" rel="rdfs-seeAlso">socket_last_error()</a> - Retorna o &uacute;ltimo erro no soquete</span></li>
    <li><span class="function"><a href="function.socket-strerror.php" class="function" rel="rdfs-seeAlso">socket_strerror()</a> - Retorna uma string descrevendo um erro no soquete</span></li>
    <li><span class="function"><a href="function.socket-write.php" class="function" rel="rdfs-seeAlso">socket_write()</a> - Escreve em um soquete</span></li>
   </ul>
  </p>
 </div>


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