php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

sem: fix XML by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-26 15:26:17 +00:00
parent 9f2874ae15
commit fd2f14b2e4
26 changed files with 216 additions and 224 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
reference/sem/book.xml
View File

@@ -1,23 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.sem" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.sem">
<?phpdoc extension-membership="bundled" ?>
<title>Semaphore, Shared Memory and IPC</title>
<titleabbrev>Semaphore</titleabbrev>
<!-- {{{ preface -->
<preface xml:id="intro.sem">
&reftitle.intro;
<para>
<simpara>
These modules provide wrappers for the System V IPC family of functions.
It includes semaphores, shared memory and inter-process messaging (IPC).
</para>
<para>
</simpara>
<simpara>
Semaphores may be used to provide exclusive access to
resources on the current machine, or to limit the number of
processes that may simultaneously use a resource.
</para>
</simpara>
<para>
This module provides also shared memory functions using System V
shared memory. Shared memory may be used to provide access to
@@ -30,7 +29,7 @@
<tgroup cols="2">
<tbody>
<row>
<entry>SHMMAX</entry>
<entry>SHMMAX</entry>
<entry>max size of shared memory, normally 131072 bytes</entry>
</row>
<row>
@@ -38,7 +37,7 @@
<entry>minimum size of shared memory, normally 1 byte</entry>
</row>
<row>
<entry>SHMMNI</entry>
<entry>SHMMNI</entry>
<entry>
max amount of shared memory segments on a system,
normally 100
@@ -54,12 +53,12 @@
</tgroup>
</table>
</para>
<para>
<simpara>
The messaging functions may be used to send and receive messages to/from
other processes. They provide a simple and effective means of exchanging
data between processes, without the need for setting up an alternative
using Unix domain sockets.
</para>
</simpara>
<note>
<simpara>
Only the shared memory functions and <function>ftok</function> are available
@@ -69,7 +68,7 @@
</note>
</preface>
<!-- }}} -->
&reference.sem.setup;
&reference.sem.constants;
&reference.sem.reference;
@@ -79,7 +78,6 @@
&reference.sem.sysvsharedmemory;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -100,4 +98,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

8
reference/sem/configure.xml
View File

@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="sem.installation" xmlns="http://docbook.org/ns/docbook">
<section xmlns="http://docbook.org/ns/docbook" xml:id="sem.installation">
&reftitle.install;
<para>
<simpara>
Support for this functions are not enabled by default.
To enable System V semaphore support compile PHP with the option
<option role="configure">--enable-sysvsem</option>.
@@ -10,9 +10,8 @@
<option role="configure">--enable-sysvshm</option>.
To enable the System V messages support compile PHP with the option
<option role="configure">--enable-sysvmsg</option>.
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -33,4 +32,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

16
reference/sem/functions/ftok.xml
View File

@@ -13,12 +13,12 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>project_id</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The function converts the <parameter>filename</parameter> of an existing
accessible file and a project identifier into an
<literal>integer</literal> for use with for example
<function>shmop_open</function> and other System V IPC keys.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,17 +27,17 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
Path to an accessible file.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>project_id</parameter></term>
<listitem>
<para>
<simpara>
Project identifier. This must be a one character string.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,10 +45,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
On success the return value will be the created key value, otherwise
<literal>-1</literal> is returned.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/sem/functions/msg-get-queue.xml
View File

@@ -13,7 +13,7 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0666</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>msg_get_queue</function> returns an id that can be used to
access the System V message queue with the given
<parameter>key</parameter>. The first call creates the message queue with
@@ -22,7 +22,7 @@
<parameter>key</parameter> will return a different message queue
identifier, but both identifiers access the same underlying message
queue.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,18 +31,18 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
Message queue numeric ID
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>permissions</parameter></term>
<listitem>
<para>
<simpara>
Queue permissions. Default to 0666. If the message queue already
exists, the <parameter>permissions</parameter> will be ignored.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,10 +50,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns <classname>SysvMessageQueue</classname> instance that can be used to access the System V message queue,
&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/sem/functions/msg-queue-exists.xml
View File

@@ -12,9 +12,9 @@
<type>bool</type><methodname>msg_queue_exists</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Checks whether the message queue <parameter>key</parameter> exists.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
Queue key.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

44
reference/sem/functions/msg-receive.xml
View File

@@ -19,11 +19,11 @@
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">error_code</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>msg_receive</function> will receive the first message from the
specified <parameter>queue</parameter> of the type specified by
<parameter>desired_message_type</parameter>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,15 +32,15 @@
<varlistentry>
<term><parameter>queue</parameter></term>
<listitem>
<para>
<simpara>
The message queue.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>desired_message_type</parameter></term>
<listitem>
<para>
<simpara>
If <parameter>desired_message_type</parameter> is 0, the message from the front
of the queue is returned. If <parameter>desired_message_type</parameter> is
greater than 0, then the first message of that type is returned.
@@ -51,53 +51,53 @@
message arrives on the queue. You can prevent the script from blocking
by specifying <constant>MSG_IPC_NOWAIT</constant> in the
<parameter>flags</parameter> parameter.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>received_message_type</parameter></term>
<listitem>
<para>
<simpara>
The type of the message that was received will be stored in this
parameter.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_message_size</parameter></term>
<listitem>
<para>
<simpara>
The maximum size of message to be accepted is specified by the
<parameter>max_message_size</parameter>; if the message in the queue is larger
than this size the function will fail (unless you set
<parameter>flags</parameter> as described below).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The received message will be stored in <parameter>message</parameter>,
unless there were errors receiving the message.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>unserialize</parameter></term>
<listitem>
<para>
<simpara>
If set to
&true;, the message is treated as though it was serialized using the
same mechanism as the session module. The message will be unserialized
and then returned to your script. This allows you to easily receive
arrays or complex object structures from other PHP scripts, or if you
are using the WDDX serializer, from any WDDX compatible source.
</para>
<para>
</simpara>
<simpara>
If <parameter>unserialize</parameter> is &false;, the message will be
returned as a binary-safe string.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -143,10 +143,10 @@
<varlistentry>
<term><parameter>error_code</parameter></term>
<listitem>
<para>
<simpara>
If the function fails, the optional <parameter>error_code</parameter>
will be set to the value of the system errno variable.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -154,15 +154,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
<para>
</simpara>
<simpara>
Upon successful completion the message queue data structure is updated as
follows: <literal>msg_lrpid</literal> is set to the process-ID of the
calling process, <literal>msg_qnum</literal> is decremented by 1 and
<literal>msg_rtime</literal> is set to the current time.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/sem/functions/msg-remove-queue.xml
View File

@@ -12,12 +12,12 @@
<type>bool</type><methodname>msg_remove_queue</methodname>
<methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>msg_remove_queue</function> destroys the message queue specified
by the <parameter>queue</parameter>. Only use this function when all
processes have finished working with the message queue and you need to
release the system resources held by it.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
<varlistentry>
<term><parameter>queue</parameter></term>
<listitem>
<para>
<simpara>
The message queue.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

40
reference/sem/functions/msg-send.xml
View File

@@ -17,11 +17,11 @@
<methodparam choice="opt"><type>bool</type><parameter>blocking</parameter><initializer>&true;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">error_code</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>msg_send</function> sends a <parameter>message</parameter> of type
<parameter>message_type</parameter> (which MUST be greater than 0) to
the message queue specified by <parameter>queue</parameter>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,38 +30,38 @@
<varlistentry>
<term><parameter>queue</parameter></term>
<listitem>
<para>
<simpara>
The message queue.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message_type</parameter></term>
<listitem>
<para>
<simpara>
The type of the message (MUST be greater than 0)
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
<simpara>
The body of the message.
</para>
</simpara>
<note>
<para>
<simpara>
If <parameter>serialize</parameter> set to &false; is supplied,
MUST be of type: <type>string</type>, <type>int</type>, <type>float</type>
or <type>bool</type>. In other case a warning will be issued.
</para>
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>serialize</parameter></term>
<listitem>
<para>
<simpara>
The optional <parameter>serialize</parameter> controls how the
<parameter>message</parameter> is sent. <parameter>serialize</parameter>
defaults to &true; which means that the <parameter>message</parameter> is
@@ -69,13 +69,13 @@
sent to the queue. This allows complex arrays and objects to be sent to
other PHP scripts, or if you are using the WDDX serializer, to any WDDX
compatible client.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blocking</parameter></term>
<listitem>
<para>
<simpara>
If the message is too large to fit in the queue, your script will wait
until another process reads messages from the queue and frees enough
space for your message to be sent.
@@ -86,15 +86,15 @@
<parameter>error_code</parameter> to <constant>MSG_EAGAIN</constant>,
indicating that you should try to send your message again a little
later on.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error_code</parameter></term>
<listitem>
<para>
<simpara>
If the function fails, the optional errorcode will be set to the value of the system errno variable.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -102,15 +102,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
<para>
</simpara>
<simpara>
Upon successful completion the message queue data structure is updated as
follows: <parameter>msg_lspid</parameter> is set to the process-ID of the
calling process, <parameter>msg_qnum</parameter> is incremented by 1 and
<parameter>msg_stime</parameter> is set to the current time.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

20
reference/sem/functions/msg-set-queue.xml
View File

@@ -13,18 +13,18 @@
<methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
<methodparam><type>array</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>msg_set_queue</function> allows you to change the values of the
msg_perm.uid, msg_perm.gid, msg_perm.mode and msg_qbytes fields of the
underlying message queue data structure.
</para>
<para>
</simpara>
<simpara>
Changing the data structure will require that PHP be running as the same
user that created the queue, owns the queue (as determined by the
existing msg_perm.xxx fields), or be running with root privileges.
root privileges are required to raise the msg_qbytes values above the
system defined limit.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,18 +33,18 @@
<varlistentry>
<term><parameter>queue</parameter></term>
<listitem>
<para>
<simpara>
The message queue.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
You specify the values you require by setting the value of the keys
that you require in the <parameter>data</parameter> array.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/sem/functions/msg-stat-queue.xml
View File

@@ -12,12 +12,12 @@
<type class="union"><type>array</type><type>false</type></type><methodname>msg_stat_queue</methodname>
<methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>msg_stat_queue</function> returns the message queue meta data
for the message queue specified by the <parameter>queue</parameter>.
This is useful, for example, to determine which process sent the message
that was just received.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
<varlistentry>
<term><parameter>queue</parameter></term>
<listitem>
<para>
<simpara>
The message queue.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -109,9 +109,9 @@
</tgroup>
</table>
</para>
<para>
<simpara>
Returns &false; on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

20
reference/sem/functions/sem-acquire.xml
View File

@@ -13,17 +13,17 @@
<methodparam><type>SysvSemaphore</type><parameter>semaphore</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>non_blocking</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>sem_acquire</function> by default blocks (if necessary) until the
semaphore can be acquired. A process attempting to acquire a semaphore which
it has already acquired will block forever if acquiring the semaphore would
cause its maximum number of semaphore to be exceeded.
</para>
<para>
</simpara>
<simpara>
After processing a request, any semaphores acquired by the process but not
explicitly released will be released automatically and a warning will be
generated.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,21 +32,21 @@
<varlistentry>
<term><parameter>semaphore</parameter></term>
<listitem>
<para>
<simpara>
<parameter>semaphore</parameter> is a semaphore
obtained from <function>sem_get</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>non_blocking</parameter></term>
<listitem>
<para>
<simpara>
Specifies if the process shouldn't wait for the semaphore to be acquired.
If set to &true;, the call will return
&false; immediately if a semaphore cannot be immediately
acquired.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -54,9 +54,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

32
reference/sem/functions/sem-get.xml
View File

@@ -15,19 +15,19 @@
<methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0666</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>auto_release</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>sem_get</function> returns an id that can be used to
access the System V semaphore with the given <parameter>key</parameter>.
</para>
<para>
</simpara>
<simpara>
A second call to <function>sem_get</function> for the same key
will return a different semaphore identifier, but both
identifiers access the same underlying semaphore.
</para>
<para>
</simpara>
<simpara>
If <parameter>key</parameter> is <literal>0</literal>, a new private semaphore
is created for each call to <function>sem_get</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -36,36 +36,36 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
</para>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_acquire</parameter></term>
<listitem>
<para>
<simpara>
The number of processes that can acquire the semaphore simultaneously
is set to <parameter>max_acquire</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>permissions</parameter></term>
<listitem>
<para>
<simpara>
The semaphore permissions. Actually this value is
set only if the process finds it is the only process currently
attached to the semaphore.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auto_release</parameter></term>
<listitem>
<para>
<simpara>
Specifies if the semaphore should be automatically released on request
shutdown.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -73,10 +73,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a positive semaphore identifier on success, or &false; on
error.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/sem/functions/sem-release.xml
View File

@@ -12,15 +12,15 @@
<type>bool</type><methodname>sem_release</methodname>
<methodparam><type>SysvSemaphore</type><parameter>semaphore</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>sem_release</function> releases the semaphore if it
is currently acquired by the calling process, otherwise
a warning is generated.
</para>
<para>
</simpara>
<simpara>
After releasing the semaphore, <function>sem_acquire</function>
may be called to re-acquire it.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,10 +29,10 @@
<varlistentry>
<term><parameter>semaphore</parameter></term>
<listitem>
<para>
<simpara>
A Semaphore as returned by
<function>sem_get</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/sem/functions/sem-remove.xml
View File

@@ -12,12 +12,12 @@
<type>bool</type><methodname>sem_remove</methodname>
<methodparam><type>SysvSemaphore</type><parameter>semaphore</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>sem_remove</function> removes the given semaphore.
</para>
<para>
</simpara>
<simpara>
After removing the semaphore, it is no longer accessible.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,10 +26,10 @@
<varlistentry>
<term><parameter>semaphore</parameter></term>
<listitem>
<para>
<simpara>
A semaphore as returned
by <function>sem_get</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

24
reference/sem/functions/shm-attach.xml
View File

@@ -14,20 +14,20 @@
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>size</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0666</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
<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>size</parameter> and the optional perm-bits
<parameter>permissions</parameter>.
</para>
<para>
</simpara>
<simpara>
A second call to <function>shm_attach</function> for the same
<parameter>key</parameter> will return a different <classname>SysvSharedMemory</classname>
instance, but both instances access the same underlying
shared memory. <parameter>size</parameter> and
<parameter>permissions</parameter> will be ignored.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -36,27 +36,27 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
A numeric shared memory segment ID
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
<simpara>
The memory size. If not provided, default to the
<literal>sysvshm.init_mem</literal> in the &php.ini;, otherwise 10000
bytes.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>permissions</parameter></term>
<listitem>
<para>
<simpara>
The optional permission bits. Default to 0666.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -64,9 +64,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a <classname>SysvSharedMemory</classname> instance on success, &return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/sem/functions/shm-detach.xml
View File

@@ -12,12 +12,12 @@
<type>bool</type><methodname>shm_detach</methodname>
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shm_detach</function> disconnects from the shared memory given
by the <parameter>shm</parameter> created by
<function>shm_attach</function>. Remember, that shared memory still exist
in the Unix system and the data is still present.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
<varlistentry>
<term><parameter>shm</parameter></term>
<listitem>
<para>
<simpara>
A shared memory segment obtained from <function>shm_attach</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -36,9 +36,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/sem/functions/shm-get-var.xml
View File

@@ -13,11 +13,11 @@
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shm_get_var</function> returns the variable with a given
<parameter>key</parameter>, in the given shared memory segment.
The variable is still present in the shared memory.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>shm</parameter></term>
<listitem>
<para>
<simpara>
A shared memory segment obtained from <function>shm_attach</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
The variable key.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,9 +44,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the variable with the given key.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/sem/functions/shm-has-var.xml
View File

@@ -13,9 +13,9 @@
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Checks whether a specific key exists inside a shared memory segment.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>shm</parameter></term>
<listitem>
<para>
<simpara>
A shared memory segment obtained from <function>shm_attach</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
The variable key.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,9 +42,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the entry exists, otherwise &false;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

24
reference/sem/functions/shm-put-var.xml
View File

@@ -14,17 +14,17 @@
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shm_put_var</function> inserts or updates the
<parameter>value</parameter> with the given
<parameter>key</parameter>.
</para>
<para>
</simpara>
<simpara>
Warnings (<constant>E_WARNING</constant> level) will be issued if
<parameter>shm</parameter> is not a valid SysV shared memory
index or if there was not enough shared memory remaining to complete your
request.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,28 +33,28 @@
<varlistentry>
<term><parameter>shm</parameter></term>
<listitem>
<para>
<simpara>
A shared memory segment obtained from <function>shm_attach</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
The variable key.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
<simpara>
The variable. All <link linkend="language.types">variable types</link>
that <function>serialize</function> supports may be used: generally
this means all types except for resources and some internal objects
that cannot be serialized.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +62,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/sem/functions/shm-remove-var.xml
View File

@@ -14,10 +14,10 @@
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Removes a variable with a given <parameter>key</parameter>
and frees the occupied memory.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>shm</parameter></term>
<listitem>
<para>
<simpara>
A shared memory segment obtained from <function>shm_attach</function>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
The variable key.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,9 +44,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/sem/functions/shm-remove.xml
View File

@@ -12,10 +12,10 @@
<type>bool</type><methodname>shm_remove</methodname>
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shm_remove</function> removes the shared memory
<parameter>shm</parameter>. All data will be destroyed.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>shm</parameter></term>
<listitem>
<para>
<simpara>
A shared memory segment obtained from <function>shm_attach</function>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

4
reference/sem/ini.xml
View File

@@ -40,9 +40,9 @@
<type>int</type>
</term>
<listitem>
<para>
<simpara>
A default size of the shared memory segment.
</para>
</simpara>
</listitem>
</varlistentry>

9
reference/sem/setup.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="sem.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sem.setup">
&reftitle.setup;
<!-- {{{ Installation -->
@@ -16,17 +15,16 @@
<section xml:id="sem.resources">
&reftitle.resources;
<para>
<simpara>
Prior to PHP 8.0.0, this extension defined the resource types
<literal>sysvmsg queue</literal> (System V Message Queue),
<literal>sysvsem</literal> (System V Semaphore) and
<literal>sysvshm</literal> (System V Shared Memory).
</para>
</simpara>
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -47,4 +45,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

6
reference/sem/sysvmessagequeue.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.sysvmessagequeue" role="class" xmlns="http://docbook.org/ns/docbook">
<reference xmlns="http://docbook.org/ns/docbook" xml:id="class.sysvmessagequeue" role="class">
<title>The SysvMessageQueue class</title>
<titleabbrev>SysvMessageQueue</titleabbrev>
@@ -8,9 +8,9 @@
<!-- {{{ SysvMessageQueue intro -->
<section xml:id="sysvmessagequeue.intro">
&reftitle.intro;
<para>
<simpara>
A fully opaque class which replaces a <literal>sysvmsg queue</literal> resource as of PHP 8.0.0.
</para>
</simpara>
</section>
<!-- }}} -->

6
reference/sem/sysvsemaphore.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.sysvsemaphore" role="class" xmlns="http://docbook.org/ns/docbook">
<reference xmlns="http://docbook.org/ns/docbook" xml:id="class.sysvsemaphore" role="class">
<title>The SysvSemaphore class</title>
<titleabbrev>SysvSemaphore</titleabbrev>
@@ -8,9 +8,9 @@
<!-- {{{ SysvSemaphore intro -->
<section xml:id="sysvsemaphore.intro">
&reftitle.intro;
<para>
<simpara>
A fully opaque class which replaces a <literal>sysvsem</literal> resource as of PHP 8.0.0.
</para>
</simpara>
</section>
<!-- }}} -->

6
reference/sem/sysvsharedmemory.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.sysvsharedmemory" role="class" xmlns="http://docbook.org/ns/docbook">
<reference xmlns="http://docbook.org/ns/docbook" xml:id="class.sysvsharedmemory" role="class">
<title>The SysvSharedMemory class</title>
<titleabbrev>SysvSharedMemory</titleabbrev>
@@ -8,9 +8,9 @@
<!-- {{{ SysvSharedMemory intro -->
<section xml:id="sysvsharedmemory.intro">
&reftitle.intro;
<para>
<simpara>
A fully opaque class which replaces a <literal>sysvshm</literal> resource as of PHP 8.0.0.
</para>
</simpara>
</section>
<!-- }}} -->