sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

tidying a bit

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@157397 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Damien Seguy 2004-04-28 11:39:18 +00:00
parent 68c74bf549
commit c522426a49
9 changed files with 54 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
reference/sem/functions/msg-receive.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.msg-receive">
<refnamediv>
<refname>msg_receive</refname>
@ -44,7 +44,8 @@
absolute value of <parameter>desiredmsgtype</parameter> will be read.
If no messages match the criteria, your script will wait until a suitable
message arrives on the queue. You can prevent the script from blocking
by specifying MSG_IPC_NOWAIT in the <parameter>flags</parameter> parameter.
by specifying <constant>MSG_IPC_NOWAIT</constant> in the
<parameter>flags</parameter> parameter.
</para>
<para>
<parameter>unserialize</parameter> defaults to &true;; if it is set to
@ -65,7 +66,7 @@
<tgroup cols="2">
<tbody>
<row>
<entry>MSG_IPC_NOWAIT</entry>
<entry><constant>MSG_IPC_NOWAIT</constant></entry>
<entry>If there are no messages of the
<parameter>desiredmsgtype</parameter>, return immediately and do not
wait. The function will fail and return an integer value
@ -73,14 +74,14 @@
</entry>
</row>
<row>
<entry>MSG_EXCEPT</entry>
<entry><constant>MSG_IPC_NOWAIT</constant></entry>
<entry>Using this flag in combination with a
<parameter>desiredmsgtype</parameter> greater than 0 will cause the
function to receive the first message that is not equal to
<parameter>desiredmsgtype</parameter>.</entry>
</row>
<row>
<entry>MSG_NOERROR</entry>
<entry><constant>MSG_IPC_NOWAIT</constant></entry>
<entry>
If the message is longer than <parameter>maxsize</parameter>,
setting this flag will truncate the message to
@ -93,9 +94,9 @@
</para>
<para>
Upon successful completion the message queue data structure is updated as
follows: <parameter>msg_lrpid</parameter> is set to the process-ID of the
calling process, <parameter>msg_qnum</parameter> is decremented by 1 and
<parameter>msg_rtime</parameter> is set to the current time.
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>
<para>
<function>msg_receive</function> returns &true; on success or &false; on

22
reference/sem/functions/msg-stat-queue.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.msg-stat-queue">
<refnamediv>
<refname>msg_stat_queue</refname>
@ -27,62 +27,62 @@
<tgroup cols="2">
<tbody>
<row>
<entry>msg_perm.uid</entry>
<entry><literal>msg_perm.uid</literal></entry>
<entry>
The uid of the owner of the queue.
</entry>
</row>
<row>
<entry>msg_perm.gid</entry>
<entry><literal>msg_perm.gid</literal></entry>
<entry>
The gid of the owner of the queue.
</entry>
</row>
<row>
<entry>msg_perm.mode</entry>
<entry><literal>msg_perm.mode</literal></entry>
<entry>
The file access mode of the queue.
</entry>
</row>
<row>
<entry>msg_stime</entry>
<entry><literal>msg_stime</literal></entry>
<entry>
The time that the last message was sent to the queue.
</entry>
</row>
<row>
<entry>msg_rtime</entry>
<entry><literal>msg_rtime</literal></entry>
<entry>
The time that the last message was received from the queue.
</entry>
</row>
<row>
<entry>msg_ctime</entry>
<entry><literal>msg_ctime</literal></entry>
<entry>
The time that the queue was last changed.
</entry>
</row>
<row>
<entry>msg_qnum</entry>
<entry><literal>msg_qnum</literal></entry>
<entry>
The number of messages waiting to be read from the queue.
</entry>
</row>
<row>
<entry>msg_qbytes</entry>
<entry><literal>msg_qbytes</literal></entry>
<entry>
The number of bytes of space currently available in the queue to
hold sent messages until they are received.
</entry>
</row>
<row>
<entry>msg_lspid</entry>
<entry><literal>msg_lspid</literal></entry>
<entry>
The pid of the process that sent the last message to the queue.
</entry>
</row>
<row>
<entry>msg_lrpid</entry>
<entry><literal>msg_lrpid</literal></entry>
<entry>
The pid of the process that received the last message from the queue.
</entry>

11
reference/sem/functions/sem-acquire.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
<refentry id="function.sem-acquire">
<refnamediv>
@ -16,8 +16,10 @@
<function>sem_acquire</function> 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 max_acquire value to
be exceeded.
if acquiring the semaphore would cause its maximum number
of semaphore to be exceeded.
<parameter>sem_identifier</parameter> is a semaphore ressource,
obtained from <function>sem_get</function>.
</para>
<para>
&return.success;
@ -28,7 +30,8 @@
and a warning will be generated.
</para>
<para>
See also: <function>sem_get</function> and
See also
<function>sem_get</function>, and
<function>sem_release</function>.
</para>
</refsect1>

10
reference/sem/functions/sem-get.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
<refentry id="function.sem-get">
<refnamediv>
@ -16,10 +16,10 @@
</methodsynopsis>
<para>
<function>sem_get</function> returns an id that can be used to
access the System V semaphore with the given key. The semaphore
is created if necessary using the permission bits specified in
perm (defaults to 0666). The number of processes that can
acquire the semaphore simultaneously is set to max_acquire
access the System V semaphore with the given <parameter>key</parameter>.
The semaphore is created if necessary using the permission bits specified in
<parameter>perm</parameter> (defaults to 0666). The number of processes that can
acquire the semaphore simultaneously is set to <parameter>max_acquire</parameter>
(defaults to 1). Actually this value is set only if the process
finds it is the only process currently attached to the semaphore.
</para>

9
reference/sem/functions/shm-get-var.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
<refentry id="function.shm-get-var">
<refnamediv>
@ -10,12 +10,15 @@
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>shm_get_var</methodname>
<methodparam><type>int</type><parameter>id</parameter></methodparam>
<methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>variable_key</parameter></methodparam>
</methodsynopsis>
<para>
<function>shm_get_var</function> returns the variable with a given
<parameter>variable_key</parameter>. The variable is still present
<parameter>variable_key</parameter>, in the shared memory
segment identified by <parameter>shm_identifier</parameter>.
<parameter>shm_identifier</parameter> was obtained from
<function>shm_attach</function>. The variable is still present
in the shared memory.
</para>
</refsect1>

14
reference/sem/functions/shm-put-var.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
<refentry id="function.shm-put-var">
<refnamediv>
<refname>shm_put_var</refname>
<refpurpose>Inserts or updates a variable in shared
memory</refpurpose>
<refpurpose>
Inserts or updates a variable in shared memory
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -16,9 +17,10 @@
<methodparam><type>mixed</type><parameter>variable</parameter></methodparam>
</methodsynopsis>
<para>
Inserts or updates a <parameter>variable</parameter> with a given
<parameter>variable_key</parameter>. <link
linkend="language.types">All variable-types</link> are supported.
<function>shm_put_var</function> inserts or updates the
<parameter>variable</parameter> with the given
<parameter>variable_key</parameter>.
<link linkend="language.types">All variable-types</link> are supported.
</para>
<para>
&return.success;

4
reference/sem/functions/shm-remove-var.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.18 -->
<refentry id="function.shm-remove-var">
<refnamediv>
@ -11,7 +11,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>shm_remove_var</methodname>
<methodparam><type>int</type><parameter>id</parameter></methodparam>
<methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>variable_key</parameter></methodparam>
</methodsynopsis>
<para>

6
reference/sem/functions/shm-remove.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
<refentry id="function.shm-remove">
<refnamediv>
@ -13,8 +13,8 @@
<methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Removes shared memory from Unix systems. All data will be
destroyed.
<function>shm_remove</function> removes the shared memory
<parameter>shm_identifier</parameter>. All data will be destroyed.
</para>
<para>
See also <function>shm_remove_var</function>.

4
reference/sem/reference.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<reference id="ref.sem">
<title>Semaphore, Shared Memory and IPC Functions</title>
<titleabbrev>Semaphore</titleabbrev>
@ -73,6 +73,8 @@
&no.config;
</section>
&reference.sem.ini;
<section id="sem.resources">
&reftitle.resources;
<para>