archived-doc-es/reference/sem/functions/shm-attach.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d0ded87aafbc0fbc7c0198daedc1570bd65cacb3 Maintainer: seros Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-attach">
 <refnamediv>
  <refname>shm_attach</refname>
  <refpurpose>Crea o abre un segmento de memoria compartida</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>shm_attach</methodname>
   <methodparam><type>int</type><parameter>key</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>memsize</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>perm</parameter><initializer>0666</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>shm_attach</function> devuelve un id que se puede usar para acceder
   a la memoria compartida de System V con la clave dada por <parameter>key</parameter>, la
   primera llamada crea el segmento de memoria compartida con
   <parameter>memsize</parameter> y los permisos opcionales a nivel de bits
   <parameter>perm</parameter>.
  </para>
  <para>
   Una segunda llamada a <function>shm_attach</function> para la misma clave dada por
   <parameter>key</parameter> devolverá un identificador de memoria
   diferente, pero ambos identificadores acceden a la misma memoria compartida
   subyacente. <parameter>memsize</parameter> y
   <parameter>perm</parameter> serán ignorados.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Un ID numérico de segmento de memoria compartida
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>memsize</parameter></term>
     <listitem>
      <para>
       El tamaño de la memoria. Si no se proporciona, por defecto es el valor de
       <literal>sysvshm.init_mem</literal> del &php.ini;, de otro modo es 10000
       bytes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>perm</parameter></term>
     <listitem>
      <para>
       Los bits de permiso opcionales. Por defecto es 0666.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un identificador de segmento de memoria compartida.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.0</entry>
       <entry>
        Esta función ahora devuelve un &resource; en vez de un
        <link linkend="language.types.integer">integer</link>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Esta función solía devolver un valor integer antes de
    PHP 5.3.0. Para obtener el mismo valor de un modo portable, el
    valor devuelto puede ser convertido a un integer:
   </para>
   <para>
    <example>
     <programlisting role="php">
<![CDATA[
<?php
// Crear un fichero temporal y devolver su ruta
$tmp = tempnam('/tmp', 'PHP');

// Obtener la clave de token del fichero
$key = ftok($tmp, 'a');

// Adjuntar el recurso SHM, observe la conversión después
$id = shm_attach($key);

if ($id === false) {
    die('No se pudo crear el segmento de memoria compartida');
}

// Convertir a integer, ya que antes de PHP 5.3.0 se devuelve
// el id del recurso, el cual puede ser expuesto cuando se convierte un recurso
// en un integer
$id = (integer) $id;
?>
]]>
     </programlisting>
    </example>
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>shm_detach</function></member>
    <member><function>ftok</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
-->