<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.shmop.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.shmop-open.php',
    1 => 'shmop_open',
    2 => 'Cria ou abre um bloco de mem&oacute;ria compartilhada',
  ),
  'up' => 
  array (
    0 => 'ref.shmop.php',
    1 => 'Fun&ccedil;&otilde;es para Mem&oacute;ria Compartilhada',
  ),
  'prev' => 
  array (
    0 => 'function.shmop-delete.php',
    1 => 'shmop_delete',
  ),
  'next' => 
  array (
    0 => 'function.shmop-read.php',
    1 => 'shmop_read',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/shmop/functions/shmop-open.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.shmop-open" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">shmop_open</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">shmop_open</span> &mdash; <span class="dc-title">Cria ou abre um bloco de memória compartilhada</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.shmop-open-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>shmop_open</strong></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">$key</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$mode</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">$permissions</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">$size</code></span><br>): <span class="type"><span class="type"><a href="class.shmop.php" class="type Shmop">Shmop</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   <span class="function"><strong>shmop_open()</strong></span> pode criar ou abrir um bloco de memória compartilhada.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.shmop-open-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">key</code></dt>
     <dd>
      <span class="simpara">
       ID do sistema para o bloco de memória compartilhada.
       Pode ser passado como decimal ou hexadecimal.
      </span>
     </dd>
    
    
     <dt><code class="parameter">mode</code></dt>
     <dd>
      <p class="para">
       As opções que podem ser usadas:
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          &quot;a&quot; para acesso (define SHM_RDONLY para shmat).
          Usada para abrir um segmento de memória compartilhada
          existente para somente leitura.
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          &quot;c&quot; para criação (define IPC_CREATE).
          Usada para criar um novo segmento de memória compartilhada
          ou, se um segmento com a mesma chave existir, para abri-lo para leitura
          e gravação.
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          &quot;w&quot; para acesso de leitura e gravação.
          Usada para ler e escrever em um segmento de memória
          compartilhada. É usada na maioria dos casos.
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          &quot;n&quot; para criar um novo segmento de memória (define IPC_CREATE|IPC_EXCL)
          Usada para criar um novo segmento de memória compartilhada,
          porém se existir um com a mesma chave, irá falhar. É útil
          para segurança, pois assim é possível evitar ataques de condição de
          corrida.
         </span>
        </li>
       </ul>
      </p>
     </dd>
    
    
     <dt><code class="parameter">permissions</code></dt>
     <dd>
      <span class="simpara">
       As permissões a atribuir ao segmento de memória,
       as mesmas das permissões de um arquivo. As permissões precisam ser passadas
       em formato octal, como por exemplo <code class="literal">0644</code>.
      </span>
     </dd>
    
    
     <dt><code class="parameter">size</code></dt>
     <dd>
      <span class="simpara">
       O tamanho do bloco de memória compartilhada a ser criado, em bytes.
      </span>
     </dd>
    
   </dl>
   <blockquote class="note"><p><strong class="note">Nota</strong>: 
    <span class="simpara">
     Nota: o 3º e o 4º parâmetros devem ser informados como 0 se um segmento de memória
     existente estiver sendo aberto.
    </span>
   </p></blockquote>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.shmop-open-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="simpara">
   Em caso de sucesso, <span class="function"><strong>shmop_open()</strong></span> retornará uma instância de <span class="classname"><a href="class.shmop.php" class="classname">Shmop</a></span> que
   pode ser usada para acessar o segmento de memória compartilhada criado. <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> é
   retornado em caso de falha.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.shmop-open-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="simpara">
   Se <code class="parameter">mode</code> for inválido ou <code class="parameter">size</code> for menor ou igual a zero,
   um <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> será lançado.
   Em outras falhas, <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> será emitido.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.shmop-open-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>
       Em caso de sucesso, esta função agora retorna uma instância de <span class="classname"><a href="class.shmop.php" class="classname">Shmop</a></span>;
       anteriormente, retornava um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>.
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Se <code class="parameter">mode</code> for inválido ou <code class="parameter">size</code> for menor ou igual a zero,
       um <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> é lançado; anteriormente, era emitido um <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
       e a função retornava <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.shmop-open-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Cria um novo bloco de memória compartilhada</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$shm_key </span><span style="color: #007700">= </span><span style="color: #0000BB">ftok</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">, </span><span style="color: #DD0000">'t'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$shm_id </span><span style="color: #007700">= </span><span style="color: #0000BB">shmop_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$shm_key</span><span style="color: #007700">, </span><span style="color: #DD0000">"c"</span><span style="color: #007700">, </span><span style="color: #0000BB">0644</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <p class="simpara">
   Este exemplo abriu um bloco de memória compartilhada com um ID do sistema retornado por
   <span class="function"><a href="function.ftok.php" class="function">ftok()</a></span>.
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.shmop-open-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.shmop-close.php" class="function" rel="rdfs-seeAlso">shmop_close()</a> - Fecha um bloco de mem&oacute;ria compartilhada</span></li>
   <li><span class="function"><a href="function.shmop-delete.php" class="function" rel="rdfs-seeAlso">shmop_delete()</a> - Deleta um bloco de mem&oacute;ria compartilhada</span></li>
  </ul>
 </div>

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