File: shm-attach.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (168 lines) | stat: -rw-r--r-- 4,356 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 311151 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-attach">
 <refnamediv>
  <refname>shm_attach</refname>
  <refpurpose>Creates or open a shared memory segment</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> returns an id that can be used to access
   the System V shared memory with the given <parameter>key</parameter>, the
   first call creates the shared memory segment with 
   <parameter>memsize</parameter> and the optional perm-bits 
   <parameter>perm</parameter>.
  </para>
  <para>
   A second call to <function>shm_attach</function> for the same
   <parameter>key</parameter> will return a different shared memory
   identifier, but both identifiers access the same underlying
   shared memory. <parameter>memsize</parameter> and
   <parameter>perm</parameter> will be ignored.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       A numeric shared memory segment ID
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>memsize</parameter></term>
     <listitem>
      <para>
       The memory size. If not provided, default to the
       <literal>sysvshm.init_mem</literal> in the &php.ini;, otherwise 10000
       bytes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>perm</parameter></term>
     <listitem>
      <para>
       The optional permission bits. Default to 0666.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a shared memory segment identifier.
  </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>
         This function now returns a &resource; instead of an 
         <link linkend="language.types.integer">integer</link>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function used to return an integer value prior to 
    PHP 5.3.0. To achieve the same value in a portable manner, the 
    return value can be cast to an integer like:
   </para>
   <para>
    <example>
     <programlisting role="php">
<![CDATA[
<?php
// Create a temporary file and return its path
$tmp = tempnam('/tmp', 'PHP');

// Get the file token key
$key = ftok($tmp, 'a');

// Attach the SHM resource, notice the cast afterwards
$id = shm_attach($key);

if ($id === false) {
    die('Unable to create the shared memory segment');
}

// Cast to integer, since prior to PHP 5.3.0 the resource id 
// is returned which can be exposed when casting a resource
// to an 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
-->