<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.eio.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.eio-read.php',
    1 => 'eio_read',
    2 => 'L&ecirc; um descritor de arquivo em determinada posi&ccedil;&atilde;o',
  ),
  'up' => 
  array (
    0 => 'ref.eio.php',
    1 => 'Fun&ccedil;&otilde;es de Eio',
  ),
  'prev' => 
  array (
    0 => 'function.eio-poll.php',
    1 => 'eio_poll',
  ),
  'next' => 
  array (
    0 => 'function.eio-readahead.php',
    1 => 'eio_readahead',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/eio/functions/eio-read.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.eio-read" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">eio_read</h1>
  <p class="verinfo">(PECL eio &gt;= 0.0.1dev)</p><p class="refpurpose"><span class="refname">eio_read</span> &mdash; <span class="dc-title">Lê um descritor de arquivo em determinada posição</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.eio-read-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>eio_read</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$fd</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">$offset</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">$pri</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$data</code><span class="initializer"> = NULL</span></span><br>): <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></div>

  <p class="simpara">
   <span class="function"><strong>eio_read()</strong></span> lê até <code class="parameter">length</code>
   bytes do descrito de arquivo <code class="parameter">fd</code> na posição
   <code class="parameter">offset</code>. Os bytes lidos são armazenados no argumento
   <code class="parameter">result</code> de <code class="parameter">callback</code>.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.eio-read-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">fd</code></dt>
    <dd>
     <span class="simpara">
      Fluxo, recurso de socket ou descritor numérico de arquivo.
     </span>
    </dd>
   
   
    <dt><code class="parameter">length</code></dt>
    <dd>
     <span class="simpara">
      Número máximo de bytes para leitura.
     </span>
    </dd>
   
   
    <dt><code class="parameter">offset</code></dt>
    <dd>
     <span class="simpara">
      Posição no arquivo.
     </span>
    </dd>
   
   
    <dt><code class="parameter">pri</code></dt>
    <dd>
    <p class="para">A prioridade da requisição: <strong><code><a href="eio.constants.php#constant.eio-pri-default">EIO_PRI_DEFAULT</a></code></strong>, <strong><code><a href="eio.constants.php#constant.eio-pri-min">EIO_PRI_MIN</a></code></strong>, <strong><code><a href="eio.constants.php#constant.eio-pri-max">EIO_PRI_MAX</a></code></strong> ou <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
Se <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> for passado, o parâmetro <code class="parameter">pri</code> internamente será definido como
<strong><code><a href="eio.constants.php#constant.eio-pri-default">EIO_PRI_DEFAULT</a></code></strong>.
</p>

    </dd>
   
   
    <dt><code class="parameter">callback</code></dt>
    <dd>
     <p class="para">
A função <code class="parameter">callback</code> é chamada quando a requisição é concluída.
Ela deve corresponder ao seguinte protótipo: <div class="example-contents"><div class="phpcode"><code><span style="color: #000000">void callback(mixed $data, int $result[, resource $req]);</span></code></div></div>

<dl>

<dt><code class="parameter">data</code></dt>
<dd><p class="para">são dados personalizados passados para a requisição.</p></dd>


<dt><code class="parameter">result</code></dt>
<dd><p class="para">valor de resultado específico da requisição; basicamente, o valor retornado pela chamada de sistema
correspondente.</p></dd>


<dt><code class="parameter">req</code></dt>
<dd><p class="para">é um recurso de requisição opcional que pode ser usado com funções como <span class="function"><a href="function.eio-get-last-error.php" class="function">eio_get_last_error()</a></span>.</p></dd>

</dl>
</p>

    </dd>
   
   
    <dt><code class="parameter">data</code></dt>
    <dd>
     <span class="simpara">
      Variável arbitrária passada para <code class="parameter">callback</code>.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.eio-read-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="simpara">
  <span class="function"><strong>eio_read()</strong></span> armazena os bytes lidos no argumento
  <code class="parameter">result</code> da funcão
  <code class="parameter">callback</code>.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.eio-read-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>eio_read()</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 arquivo temporário e escreva alguns bytes nele<br /></span><span style="color: #0000BB">$temp_filename </span><span style="color: #007700">= </span><span style="color: #DD0000">"eio-temp-file.tmp"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">, </span><span style="color: #DD0000">"w"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"1234567890"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Função chamada quando eio_read() termina */<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_read_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br />    global </span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// Mostra os bytes lidos<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// Fecha o arquivo<br />    </span><span style="color: #0000BB">eio_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">eio_event_loop</span><span style="color: #007700">();<br /><br /> </span><span style="color: #FF8000">// Remove o arquivo temporário<br />    </span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Função chamada quando eio_open() termina */<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_file_opened_callback</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// $result deve conter o descritor de arquivo<br />    </span><span style="color: #007700">if (</span><span style="color: #0000BB">$result </span><span style="color: #007700">&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br />  </span><span style="color: #FF8000">// Lê 5 bytes iniciando do terceiro<br />        </span><span style="color: #0000BB">eio_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_read_cb"</span><span style="color: #007700">, </span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br />        </span><span style="color: #0000BB">eio_event_loop</span><span style="color: #007700">();<br />    } else {<br />  </span><span style="color: #FF8000">// eio_open() falhou<br />        </span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br />    }<br />}<br /><br /></span><span style="color: #FF8000">// Abre o arquivo para leitura e gravação<br /></span><span style="color: #0000BB">eio_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">, </span><span style="color: #0000BB">EIO_O_RDWR</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">,<br />    </span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_file_opened_callback"</span><span style="color: #007700">, </span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">eio_event_loop</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>O exemplo acima produzirá
algo semelhante a:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">string(5) &quot;34567&quot;</pre>
</div>
   </div>
  </div>
 </div>



 <div class="refsect1 seealso" id="refsect1-function.eio-read-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.eio-open.php" class="function" rel="rdfs-seeAlso">eio_open()</a> - Abre um arquivo</span></li>
   <li><span class="function"><a href="function.eio-write.php" class="function" rel="rdfs-seeAlso">eio_write()</a> - Escreve em um arquivo</span></li>
   <li><span class="function"><a href="function.eio-close.php" class="function" rel="rdfs-seeAlso">eio_close()</a> - Fecha arquivo</span></li>
   <li><span class="function"><a href="function.eio-event-loop.php" class="function" rel="rdfs-seeAlso">eio_event_loop()</a> - Consulta a libeio at&eacute; que todas as requisi&ccedil;&otilde;es tenham conclu&iacute;do</span></li>
  </ul>
 </div>


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