shmop-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3906c681cda6cf21e5b7034be54515ba431cb7a7 Maintainer: jesusruiz Status: ready -->
<!-- Reviewed: no Maintainer: andresdzphp -->

<refentry xml:id="function.shmop-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>shmop_open</refname>
  <refpurpose>Crea o abre un segmento de memoria compartida</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>shmop_open</methodname>
   <methodparam><type>int</type><parameter>key</parameter></methodparam>
   <methodparam><type>string</type><parameter>flags</parameter></methodparam>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>shmop_open</function> puede crear o abrir un segmento de memoria compartida.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Identificador que el sistema utilizará para ese segmento de memoria compartida.
       Puede ser indicado tanto en formato decimal como hexadecimal.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Los indicadores que puede usar son:
       <itemizedlist>
        <listitem>
         <simpara>
          "a" para acceder (establece SHM_RDONLY para shmat)
          utilice este indicador cuando necesite abrir un segmento de memoria compartida 
          de sólo lectura
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "c" para crear (establece IPC_CREATE)
          utilice este indicador cuando necesite crear un nuevo segmento de memoria compartida
          o para intentar abrir en modo de lectura y escritura un segmento que ya existe
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "w" para acceder en modo de lectura y escritura
          utilice este indicador cuando necesite leer un segmento de memoria compartida y además
          poder escribir en él, se trata de la opción más habitual en la mayoría de los casos.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "n" crea un nuevo segmento de memoria compartida (establece IPC_CREATE|IPC_EXCL)
          utilice este indicador cuando necesite crear un nuevo segmento de memoria compartida, 
          pero si existe otro segmento de memoria compartida con la misma clave, fallará. Esta opción 
          es útil para propósitos de seguridad que evitan  por ejemplo los exploit conocidos como 
          "condiciones de carrera" (en inglés "race conditions"). 
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Permisos que se van a asignar al segmento de memoria compartida, estos
       son similares a los que se asignan a los archivos. Los permisos deben pasarse
       en formato octal, como por ejemplo <literal>0644</literal>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       El tamaño en bytes del segmento de memoria compartida que quiere crear
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
   <note>
    <para>
     Nota: El tercer y cuarto parámetro deberán ser igual a 0 (cero) 
     si está abriendo un segmento de memoria compartida existente.
    </para>
   </note>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   En caso de éxito <function>shmop_open</function> devolverá un recurso que puede
   utilizar para acceder al segmento de memoria compartida que ha creado. &false; es
   devuelto en caso de fallo.
  </para>
 </refsect1>
 
  <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>7.0.0</entry>
      <entry>
       El tipo devuelto de <function>shmop_open</function> ha sido cambiado de
       <type>int</type> a <type>resource</type>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Crear un nuevo segmento de memoria compartida</title>
    <programlisting role="php">
<![CDATA[
<?php
$shm_key = ftok(__FILE__, 't');
$shm_id = shmop_open($shm_key, "c", 0644, 100);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   En este ejemplo se abre un segmento de memoria compartida con un identificador de sistema devuelto por
   <function>ftok</function>.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>shmop_close</function></member>
    <member><function>shmop_delete</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
-->