cvs: phpdoc /en/reference/sem/functions ftok.xml msg-get-queue.xml msg-receive.xml msg-remove-queue.xml msg-send.xml msg-set-queue.xml
msg-stat-queue.xml sem-acquire.xml sem-get.xml sem-release.xml sem-remove.xml shm-attach.xml shm-detach.xml shm-get-var.xml shm-put-var.xml
shm-remove-var.xml shm-remove.xml
| From: | Mehdi Achour | Date: | Fri, 15 Jun 2007 00:14:21 +0000 |
| Subject: | cvs: phpdoc /en/reference/sem/functions ftok.xml msg-get-queue.xml msg-receive.xml msg-remove-queue.xml msg-send.xml msg-set-queue.xml msg-stat-queue.xml sem-acquire.xml sem-get.xml sem-release.xml sem-remove.xml shm-attach.xml shm-detach.xml shm-get-var.xml shm-put-var.xml shm-remove-var.xml shm-remove.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969376681@lists.php.net to get a copy of this message | ||
didou Fri Jun 15 00:14:21 2007 UTC
Modified files:
/phpdoc/en/reference/sem/functions ftok.xml msg-get-queue.xml
msg-receive.xml
msg-remove-queue.xml
msg-send.xml msg-set-queue.xml
msg-stat-queue.xml
sem-acquire.xml sem-get.xml
sem-release.xml sem-remove.xml
shm-attach.xml shm-detach.xml
shm-get-var.xml shm-put-var.xml
shm-remove-var.xml
shm-remove.xml
Log:
WS, prepare for new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/ftok.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/ftok.xml diff -u phpdoc/en/reference/sem/functions/ftok.xml:1.5 phpdoc/en/reference/sem/functions/ftok.xml:1.6 --- phpdoc/en/reference/sem/functions/ftok.xml:1.5 Sun Oct 15 04:17:56 2006 +++ phpdoc/en/reference/sem/functions/ftok.xml Fri Jun 15 00:14:21 2007 @@ -1,37 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id='function.ftok'> - <refnamediv> - <refname>ftok</refname> - <refpurpose> - Convert a pathname and a project identifier to a System V IPC key - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ftok</methodname> - <methodparam><type>string</type><parameter>pathname</parameter></methodparam> - <methodparam><type>string</type><parameter>proj</parameter></methodparam> - </methodsynopsis> - <para> - The function converts the <parameter>pathname</parameter> of an existing - accessible file and a project identifier (<parameter>proj</parameter>) - into a - <literal>integer</literal> for use with for example - <function>shmop_open</function> and other System V IPC keys. The - <parameter>proj</parameter> parameter must be a one character string. - </para> - <para> - On success the return value will be the created key value, otherwise - <literal>-1</literal> is returned. - </para> - <para> - See also <function>shmop_open</function> and <function>sem_get</function>. - </para> - </refsect1> - </refentry> +<refentry id='function.ftok'> + <refnamediv> + <refname>ftok</refname> + <refpurpose>Convert a pathname and a project identifier to a System V IPC key</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ftok</methodname> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam><type>string</type><parameter>proj</parameter></methodparam> + </methodsynopsis> + <para> + The function converts the <parameter>pathname</parameter> of an existing + accessible file and a project identifier (<parameter>proj</parameter>) + into a + <literal>integer</literal> for use with for example + <function>shmop_open</function> and other System V IPC keys. The + <parameter>proj</parameter> parameter must be a one character string. + </para> + <para> + On success the return value will be the created key value, otherwise + <literal>-1</literal> is returned. + </para> + <para> + See also <function>shmop_open</function> and <function>sem_get</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-get-queue.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-get-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-get-queue.xml:1.3 phpdoc/en/reference/sem/functions/msg-get-queue.xml:1.4 --- phpdoc/en/reference/sem/functions/msg-get-queue.xml:1.3 Sun Apr 25 10:08:54 2004 +++ phpdoc/en/reference/sem/functions/msg-get-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,39 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.msg-get-queue"> - <refnamediv> - <refname>msg_get_queue</refname> - <refpurpose> - Create or attach to a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>msg_get_queue</methodname> - <methodparam><type>int</type><parameter>key</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>perms</parameter></methodparam> - </methodsynopsis> - <para> - <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 - the optional <parameter>perms</parameter> (default: 0666). - A second call to <function>msg_get_queue</function> for the same - <parameter>key</parameter> will return a different message queue - identifier, but both identifiers access the same underlying message - queue. - If the message queue already exists, the <parameter>perms</parameter> - will be ignored. - </para> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, <function>msg_send</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.msg-get-queue"> + <refnamediv> + <refname>msg_get_queue</refname> + <refpurpose>Create or attach to a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>msg_get_queue</methodname> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>perms</parameter></methodparam> + </methodsynopsis> + <para> + <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 + the optional <parameter>perms</parameter> (default: 0666). + A second call to <function>msg_get_queue</function> for the same + <parameter>key</parameter> will return a different message queue + identifier, but both identifiers access the same underlying message + queue. + If the message queue already exists, the <parameter>perms</parameter> + will be ignored. + </para> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, <function>msg_send</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-receive.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-receive.xml diff -u phpdoc/en/reference/sem/functions/msg-receive.xml:1.8 phpdoc/en/reference/sem/functions/msg-receive.xml:1.9 --- phpdoc/en/reference/sem/functions/msg-receive.xml:1.8 Tue Nov 14 12:11:02 2006 +++ phpdoc/en/reference/sem/functions/msg-receive.xml Fri Jun 15 00:14:21 2007 @@ -1,117 +1,115 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> - <refentry id="function.msg-receive"> - <refnamediv> - <refname>msg_receive</refname> - <refpurpose> - Receive a message from a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_receive</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - <methodparam><type>int</type><parameter>desiredmsgtype</parameter></methodparam> - <methodparam><type>int</type><parameter role="reference">msgtype</parameter></methodparam> - <methodparam><type>int</type><parameter>maxsize</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">message</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>unserialize</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> - </methodsynopsis> - <para> - <function>msg_receive</function> will receive the first message from the - specified <parameter>queue</parameter> of the type specified by - <parameter>desiredmsgtype</parameter>. - The type of the message that was received will be stored in - <parameter>msgtype</parameter>. - The maximum size of message to be accepted is specified by the - <parameter>maxsize</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). - The received message will be stored in <parameter>message</parameter>, - unless there were errors receiving the message, in which case the - optional <parameter>errorcode</parameter> will be set to the value of the - system errno variable to help you identify the cause. - </para> - <para> - If <parameter>desiredmsgtype</parameter> is 0, the message from the front - of the queue is returned. If <parameter>desiredmsgtype</parameter> is - greater than 0, then the first message of that type is returned. - If <parameter>desiredmsgtype</parameter> is less than 0, the first - message on the queue with the lowest type less than or equal to the - 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 <constant>MSG_IPC_NOWAIT</constant> in the - <parameter>flags</parameter> parameter. - </para> - <para> - <parameter>unserialize</parameter> defaults to &true;; if it is 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. - If <parameter>unserialize</parameter> is &false;, the message will be - returned as a binary-safe string. - </para> - <para> - The optional <parameter>flags</parameter> allows you to pass flags to the - low-level msgrcv system call. It defaults to 0, but you may specify one - or more of the following values (by adding or ORing them together). - <table> - <title>Flag values for msg_receive</title> - <tgroup cols="2"> - <tbody> - <row> - <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 - corresponding to <constant>MSG_ENOMSG</constant>. - </entry> - </row> - <row> - <entry><constant>MSG_EXCEPT</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><constant>MSG_NOERROR</constant></entry> - <entry> - If the message is longer than <parameter>maxsize</parameter>, - setting this flag will truncate the message to - <parameter>maxsize</parameter> and will not signal an error. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - 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> - <para> - <function>msg_receive</function> returns &true; on success or &false; on - failure. If the function fails, the optional - <parameter>errorcode</parameter> will be set to the value of the system - errno variable. - </para> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_send</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.9 $ --> +<refentry id="function.msg-receive"> + <refnamediv> + <refname>msg_receive</refname> + <refpurpose>Receive a message from a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_receive</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + <methodparam><type>int</type><parameter>desiredmsgtype</parameter></methodparam> + <methodparam><type>int</type><parameter role="reference">msgtype</parameter></methodparam> + <methodparam><type>int</type><parameter>maxsize</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">message</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>unserialize</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> + </methodsynopsis> + <para> + <function>msg_receive</function> will receive the first message from the + specified <parameter>queue</parameter> of the type specified by + <parameter>desiredmsgtype</parameter>. + The type of the message that was received will be stored in + <parameter>msgtype</parameter>. + The maximum size of message to be accepted is specified by the + <parameter>maxsize</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). + The received message will be stored in <parameter>message</parameter>, + unless there were errors receiving the message, in which case the + optional <parameter>errorcode</parameter> will be set to the value of the + system errno variable to help you identify the cause. + </para> + <para> + If <parameter>desiredmsgtype</parameter> is 0, the message from the front + of the queue is returned. If <parameter>desiredmsgtype</parameter> is + greater than 0, then the first message of that type is returned. + If <parameter>desiredmsgtype</parameter> is less than 0, the first + message on the queue with the lowest type less than or equal to the + 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 <constant>MSG_IPC_NOWAIT</constant> in the + <parameter>flags</parameter> parameter. + </para> + <para> + <parameter>unserialize</parameter> defaults to &true;; if it is 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. + If <parameter>unserialize</parameter> is &false;, the message will be + returned as a binary-safe string. + </para> + <para> + The optional <parameter>flags</parameter> allows you to pass flags to the + low-level msgrcv system call. It defaults to 0, but you may specify one + or more of the following values (by adding or ORing them together). + <table> + <title>Flag values for msg_receive</title> + <tgroup cols="2"> + <tbody> + <row> + <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 + corresponding to <constant>MSG_ENOMSG</constant>. + </entry> + </row> + <row> + <entry><constant>MSG_EXCEPT</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><constant>MSG_NOERROR</constant></entry> + <entry> + If the message is longer than <parameter>maxsize</parameter>, + setting this flag will truncate the message to + <parameter>maxsize</parameter> and will not signal an error. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + 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> + <para> + <function>msg_receive</function> returns &true; on success or &false; on + failure. If the function fails, the optional + <parameter>errorcode</parameter> will be set to the value of the system + errno variable. + </para> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_send</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-remove-queue.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-remove-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-remove-queue.xml:1.4 phpdoc/en/reference/sem/functions/msg-remove-queue.xml:1.5 --- phpdoc/en/reference/sem/functions/msg-remove-queue.xml:1.4 Fri Apr 22 15:39:28 2005 +++ phpdoc/en/reference/sem/functions/msg-remove-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,32 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.msg-remove-queue"> - <refnamediv> - <refname>msg_remove_queue</refname> - <refpurpose> - Destroy a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_remove_queue</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - </methodsynopsis> - <para> - <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> - <para> - See also <function>msg_get_queue</function>, - <function>msg_receive</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.msg-remove-queue"> + <refnamediv> + <refname>msg_remove_queue</refname> + <refpurpose>Destroy a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_remove_queue</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + </methodsynopsis> + <para> + <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> + <para> + See also <function>msg_get_queue</function>, + <function>msg_receive</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-send.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-send.xml diff -u phpdoc/en/reference/sem/functions/msg-send.xml:1.7 phpdoc/en/reference/sem/functions/msg-send.xml:1.8 --- phpdoc/en/reference/sem/functions/msg-send.xml:1.7 Tue Nov 14 12:11:02 2006 +++ phpdoc/en/reference/sem/functions/msg-send.xml Fri Jun 15 00:14:21 2007 @@ -1,62 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> - <refentry id="function.msg-send"> - <refnamediv> - <refname>msg_send</refname> - <refpurpose> - Send a message to a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_send</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - <methodparam><type>int</type><parameter>msgtype</parameter></methodparam> - <methodparam><type>mixed</type><parameter>message</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>serialize</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>blocking</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> - </methodsynopsis> - <para> - <function>msg_send</function> sends a <parameter>message</parameter> of type - <parameter>msgtype</parameter> (which MUST be greater than 0) to - the message queue specified by <parameter>queue</parameter>. - </para> - <para> - 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. - This is called blocking; you can prevent blocking by setting the - optional <parameter>blocking</parameter> parameter to &false;, in which - case <function>msg_send</function> will immediately return &false; if the - message is too big for the queue, and set the optional - <parameter>errorcode</parameter> to <constant>MSG_EAGAIN</constant>, indicating that you should - try to send your message again a little later on. - </para> - <para> - 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 - serialized using the same mechanism as the session module before being - 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> - <para> - 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> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<refentry id="function.msg-send"> + <refnamediv> + <refname>msg_send</refname> + <refpurpose>Send a message to a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_send</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + <methodparam><type>int</type><parameter>msgtype</parameter></methodparam> + <methodparam><type>mixed</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>serialize</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>blocking</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> + </methodsynopsis> + <para> + <function>msg_send</function> sends a <parameter>message</parameter> of type + <parameter>msgtype</parameter> (which MUST be greater than 0) to + the message queue specified by <parameter>queue</parameter>. + </para> + <para> + 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. + This is called blocking; you can prevent blocking by setting the + optional <parameter>blocking</parameter> parameter to &false;, in which + case <function>msg_send</function> will immediately return &false; if the + message is too big for the queue, and set the optional + <parameter>errorcode</parameter> to <constant>MSG_EAGAIN</constant>, indicating that you should + try to send your message again a little later on. + </para> + <para> + 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 + serialized using the same mechanism as the session module before being + 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> + <para> + 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> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-set-queue.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-set-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-set-queue.xml:1.5 phpdoc/en/reference/sem/functions/msg-set-queue.xml:1.6 --- phpdoc/en/reference/sem/functions/msg-set-queue.xml:1.5 Fri Apr 22 15:39:28 2005 +++ phpdoc/en/reference/sem/functions/msg-set-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,41 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.msg-set-queue"> - <refnamediv> - <refname>msg_set_queue</refname> - <refpurpose> - Set information in the message queue data structure - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_set_queue</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - <methodparam><type>array</type><parameter>data</parameter></methodparam> - </methodsynopsis> - <para> - <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. - You specify the values you require by setting the value of the keys that - you require in the <parameter>data</parameter> array. - </para> - <para> - 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> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, - <function>msg_stat_queue</function> and - <function>msg_get_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.msg-set-queue"> + <refnamediv> + <refname>msg_set_queue</refname> + <refpurpose>Set information in the message queue data structure</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_set_queue</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + <methodparam><type>array</type><parameter>data</parameter></methodparam> + </methodsynopsis> + <para> + <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. + You specify the values you require by setting the value of the keys that + you require in the <parameter>data</parameter> array. + </para> + <para> + 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> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, + <function>msg_stat_queue</function> and + <function>msg_get_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-stat-queue.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-stat-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-stat-queue.xml:1.5 phpdoc/en/reference/sem/functions/msg-stat-queue.xml:1.6 --- phpdoc/en/reference/sem/functions/msg-stat-queue.xml:1.5 Fri Apr 22 15:39:28 2005 +++ phpdoc/en/reference/sem/functions/msg-stat-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,104 +1,102 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.msg-stat-queue"> - <refnamediv> - <refname>msg_stat_queue</refname> - <refpurpose> - Returns information from the message queue data structure - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>msg_stat_queue</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - </methodsynopsis> - <para> - <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> - <para> - The return value is an array whose keys and values have the following - meanings: - <table> - <title>Array structure for msg_stat_queue</title> - <tgroup cols="2"> - <tbody> - <row> - <entry><literal>msg_perm.uid</literal></entry> - <entry> - The uid of the owner of the queue. - </entry> - </row> - <row> - <entry><literal>msg_perm.gid</literal></entry> - <entry> - The gid of the owner of the queue. - </entry> - </row> - <row> - <entry><literal>msg_perm.mode</literal></entry> - <entry> - The file access mode of the queue. - </entry> - </row> - <row> - <entry><literal>msg_stime</literal></entry> - <entry> - The time that the last message was sent to the queue. - </entry> - </row> - <row> - <entry><literal>msg_rtime</literal></entry> - <entry> - The time that the last message was received from the queue. - </entry> - </row> - <row> - <entry><literal>msg_ctime</literal></entry> - <entry> - The time that the queue was last changed. - </entry> - </row> - <row> - <entry><literal>msg_qnum</literal></entry> - <entry> - The number of messages waiting to be read from the queue. - </entry> - </row> - <row> - <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><literal>msg_lspid</literal></entry> - <entry> - The pid of the process that sent the last message to the queue. - </entry> - </row> - <row> - <entry><literal>msg_lrpid</literal></entry> - <entry> - The pid of the process that received the last message from the queue. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, - <function>msg_get_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.msg-stat-queue"> + <refnamediv> + <refname>msg_stat_queue</refname> + <refpurpose>Returns information from the message queue data structure</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>msg_stat_queue</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + </methodsynopsis> + <para> + <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> + <para> + The return value is an array whose keys and values have the following + meanings: + <table> + <title>Array structure for msg_stat_queue</title> + <tgroup cols="2"> + <tbody> + <row> + <entry><literal>msg_perm.uid</literal></entry> + <entry> + The uid of the owner of the queue. + </entry> + </row> + <row> + <entry><literal>msg_perm.gid</literal></entry> + <entry> + The gid of the owner of the queue. + </entry> + </row> + <row> + <entry><literal>msg_perm.mode</literal></entry> + <entry> + The file access mode of the queue. + </entry> + </row> + <row> + <entry><literal>msg_stime</literal></entry> + <entry> + The time that the last message was sent to the queue. + </entry> + </row> + <row> + <entry><literal>msg_rtime</literal></entry> + <entry> + The time that the last message was received from the queue. + </entry> + </row> + <row> + <entry><literal>msg_ctime</literal></entry> + <entry> + The time that the queue was last changed. + </entry> + </row> + <row> + <entry><literal>msg_qnum</literal></entry> + <entry> + The number of messages waiting to be read from the queue. + </entry> + </row> + <row> + <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><literal>msg_lspid</literal></entry> + <entry> + The pid of the process that sent the last message to the queue. + </entry> + </row> + <row> + <entry><literal>msg_lrpid</literal></entry> + <entry> + The pid of the process that received the last message from the queue. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, + <function>msg_get_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-acquire.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-acquire.xml diff -u phpdoc/en/reference/sem/functions/sem-acquire.xml:1.6 phpdoc/en/reference/sem/functions/sem-acquire.xml:1.7 --- phpdoc/en/reference/sem/functions/sem-acquire.xml:1.6 Thu May 4 09:00:31 2006 +++ phpdoc/en/reference/sem/functions/sem-acquire.xml Fri Jun 15 00:14:21 2007 @@ -1,41 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.sem-acquire"> - <refnamediv> - <refname>sem_acquire</refname> - <refpurpose>Acquire a semaphore</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>sem_acquire</methodname> - <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <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 maximum number - of semaphore to be exceeded. - <parameter>sem_identifier</parameter> is a semaphore resource, - obtained from <function>sem_get</function>. - </para> - <para> - &return.success; - </para> - <para> - 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> - <para> - See also - <function>sem_get</function>, and - <function>sem_release</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-acquire"> + <refnamediv> + <refname>sem_acquire</refname> + <refpurpose>Acquire a semaphore</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>sem_acquire</methodname> + <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <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 maximum number + of semaphore to be exceeded. + <parameter>sem_identifier</parameter> is a semaphore resource, + obtained from <function>sem_get</function>. + </para> + <para> + &return.success; + </para> + <para> + 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> + <para> + See also + <function>sem_get</function>, and + <function>sem_release</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-get.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-get.xml diff -u phpdoc/en/reference/sem/functions/sem-get.xml:1.9 phpdoc/en/reference/sem/functions/sem-get.xml:1.10 --- phpdoc/en/reference/sem/functions/sem-get.xml:1.9 Thu Aug 12 18:11:59 2004 +++ phpdoc/en/reference/sem/functions/sem-get.xml Fri Jun 15 00:14:21 2007 @@ -1,49 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.sem-get"> - <refnamediv> - <refname>sem_get</refname> - <refpurpose>Get a semaphore id</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>sem_get</methodname> - <methodparam><type>int</type><parameter>key</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>max_acquire</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>perm</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>auto_release</parameter></methodparam> - </methodsynopsis> - <para> - <function>sem_get</function> returns an id that can be used to - 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> - <para> - Optional parameter <parameter>auto_release</parameter> specifies if the - semaphore should be automatically released on request shutdown. - It is available since PHP 4.3.0. - </para> - <para> - Returns a positive semaphore identifier on success, or &false; on - error. - </para> - <para> - 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> - See also <function>sem_acquire</function>, - <function>sem_release</function>, and <function>ftok</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-get"> + <refnamediv> + <refname>sem_get</refname> + <refpurpose>Get a semaphore id</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>sem_get</methodname> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>max_acquire</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>perm</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>auto_release</parameter></methodparam> + </methodsynopsis> + <para> + <function>sem_get</function> returns an id that can be used to + 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> + <para> + Optional parameter <parameter>auto_release</parameter> specifies if the + semaphore should be automatically released on request shutdown. + It is available since PHP 4.3.0. + </para> + <para> + Returns a positive semaphore identifier on success, or &false; on + error. + </para> + <para> + 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> + See also <function>sem_acquire</function>, + <function>sem_release</function>, and <function>ftok</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-release.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-release.xml diff -u phpdoc/en/reference/sem/functions/sem-release.xml:1.5 phpdoc/en/reference/sem/functions/sem-release.xml:1.6 --- phpdoc/en/reference/sem/functions/sem-release.xml:1.5 Sun Apr 25 10:14:51 2004 +++ phpdoc/en/reference/sem/functions/sem-release.xml Fri Jun 15 00:14:21 2007 @@ -1,36 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.sem-release"> - <refnamediv> - <refname>sem_release</refname> - <refpurpose>Release a semaphore</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>sem_release</methodname> - <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>sem_release</function> releases the semaphore if it - is currently acquired by the calling process, otherwise - a warning is generated. - </para> - <para> - &return.success; - </para> - <para> - After releasing the semaphore, <function>sem_acquire</function> - may be called to re-acquire it. - </para> - <para> - See also - <function>sem_get</function> and - <function>sem_acquire</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-release"> + <refnamediv> + <refname>sem_release</refname> + <refpurpose>Release a semaphore</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>sem_release</methodname> + <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>sem_release</function> releases the semaphore if it + is currently acquired by the calling process, otherwise + a warning is generated. + </para> + <para> + &return.success; + </para> + <para> + After releasing the semaphore, <function>sem_acquire</function> + may be called to re-acquire it. + </para> + <para> + See also + <function>sem_get</function> and + <function>sem_acquire</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-remove.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-remove.xml diff -u phpdoc/en/reference/sem/functions/sem-remove.xml:1.5 phpdoc/en/reference/sem/functions/sem-remove.xml:1.6 --- phpdoc/en/reference/sem/functions/sem-remove.xml:1.5 Sun Apr 25 10:14:51 2004 +++ phpdoc/en/reference/sem/functions/sem-remove.xml Fri Jun 15 00:14:21 2007 @@ -1,36 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.7 --> - <refentry id="function.sem-remove"> - <refnamediv> - <refname>sem_remove</refname> - <refpurpose>Remove a semaphore</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>sem_remove</methodname> - <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>sem_remove</function> removes the semaphore - <parameter>sem_identifier</parameter> if it - has been created by <function>sem_get</function>, - otherwise generates a warning. - </para> - <para> - &return.success; - </para> - <para> - After removing the semaphore, it is no more accessible. - </para> - <para> - See also <function>sem_get</function>, - <function>sem_release</function> and - <function>sem_acquire</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-remove"> + <refnamediv> + <refname>sem_remove</refname> + <refpurpose>Remove a semaphore</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>sem_remove</methodname> + <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>sem_remove</function> removes the semaphore + <parameter>sem_identifier</parameter> if it + has been created by <function>sem_get</function>, + otherwise generates a warning. + </para> + <para> + &return.success; + </para> + <para> + After removing the semaphore, it is no more accessible. + </para> + <para> + See also <function>sem_get</function>, + <function>sem_release</function> and + <function>sem_acquire</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-attach.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-attach.xml diff -u phpdoc/en/reference/sem/functions/shm-attach.xml:1.8 phpdoc/en/reference/sem/functions/shm-attach.xml:1.9 --- phpdoc/en/reference/sem/functions/shm-attach.xml:1.8 Sat Feb 3 12:38:30 2007 +++ phpdoc/en/reference/sem/functions/shm-attach.xml Fri Jun 15 00:14:21 2007 @@ -1,39 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.shm-attach"> - <refnamediv> - <refname>shm_attach</refname> - <refpurpose>Creates or open a shared memory segment</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</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></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> - (default: sysvshm.init_mem in the &php.ini;, otherwise - 10000 bytes) and the optional perm-bits <parameter>perm</parameter> - (default: 0666). - </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> - <para> - See also <function>ftok</function>, and <function>shm_detach</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-attach"> + <refnamediv> + <refname>shm_attach</refname> + <refpurpose>Creates or open a shared memory segment</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</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></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> + (default: sysvshm.init_mem in the &php.ini;, otherwise + 10000 bytes) and the optional perm-bits <parameter>perm</parameter> + (default: 0666). + </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> + <para> + See also <function>ftok</function>, and <function>shm_detach</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-detach.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-detach.xml diff -u phpdoc/en/reference/sem/functions/shm-detach.xml:1.5 phpdoc/en/reference/sem/functions/shm-detach.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-detach.xml:1.5 Sun Apr 25 10:20:20 2004 +++ phpdoc/en/reference/sem/functions/shm-detach.xml Fri Jun 15 00:14:21 2007 @@ -1,32 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.shm-detach"> - <refnamediv> - <refname>shm_detach</refname> - <refpurpose>Disconnects from shared memory segment</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_detach</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>shm_detach</function> disconnects from the shared - memory given by the <parameter>shm_identifier</parameter> created - by <function>shm_attach</function>. Remember, that shared memory - still exist in the Unix system and the data is still present. - </para> - <para> - <function>shm_detach</function> always returns &true;. - </para> - <para> - See also <function>shm_attach</function>, <function>shm_remove</function>, - and <function>shm_remove_var</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-detach"> + <refnamediv> + <refname>shm_detach</refname> + <refpurpose>Disconnects from shared memory segment</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_detach</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>shm_detach</function> disconnects from the shared + memory given by the <parameter>shm_identifier</parameter> created + by <function>shm_attach</function>. Remember, that shared memory + still exist in the Unix system and the data is still present. + </para> + <para> + <function>shm_detach</function> always returns &true;. + </para> + <para> + See also <function>shm_attach</function>, <function>shm_remove</function>, + and <function>shm_remove_var</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-get-var.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-get-var.xml diff -u phpdoc/en/reference/sem/functions/shm-get-var.xml:1.4 phpdoc/en/reference/sem/functions/shm-get-var.xml:1.5 --- phpdoc/en/reference/sem/functions/shm-get-var.xml:1.4 Wed Apr 28 11:39:18 2004 +++ phpdoc/en/reference/sem/functions/shm-get-var.xml Fri Jun 15 00:14:21 2007 @@ -1,28 +1,28 @@ <?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-get-var"> - <refnamediv> - <refname>shm_get_var</refname> - <refpurpose>Returns a variable from shared memory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>shm_get_var</methodname> - <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>, 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> - </refentry> +<refentry id="function.shm-get-var"> + <refnamediv> + <refname>shm_get_var</refname> + <refpurpose>Returns a variable from shared memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>shm_get_var</methodname> + <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>, 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> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-put-var.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-put-var.xml diff -u phpdoc/en/reference/sem/functions/shm-put-var.xml:1.5 phpdoc/en/reference/sem/functions/shm-put-var.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-put-var.xml:1.5 Wed Apr 28 11:39:18 2004 +++ phpdoc/en/reference/sem/functions/shm-put-var.xml Fri Jun 15 00:14:21 2007 @@ -1,38 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- 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> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_put_var</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> - <methodparam><type>mixed</type><parameter>variable</parameter></methodparam> - </methodsynopsis> - <para> - <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; - </para> - <para> - Warnings (<literal>E_WARNING</literal> level) will be issued if - <parameter>shm_identifier</parameter> is not a valid SysV shared memory - index or if there was not enough shared memory remaining to complete your - request. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-put-var"> + <refnamediv> + <refname>shm_put_var</refname> + <refpurpose>Inserts or updates a variable in shared memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_put_var</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> + <methodparam><type>mixed</type><parameter>variable</parameter></methodparam> + </methodsynopsis> + <para> + <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; + </para> + <para> + Warnings (<literal>E_WARNING</literal> level) will be issued if + <parameter>shm_identifier</parameter> is not a valid SysV shared memory + index or if there was not enough shared memory remaining to complete your + request. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-remove-var.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-remove-var.xml diff -u phpdoc/en/reference/sem/functions/shm-remove-var.xml:1.5 phpdoc/en/reference/sem/functions/shm-remove-var.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-remove-var.xml:1.5 Fri Jun 24 09:11:46 2005 +++ phpdoc/en/reference/sem/functions/shm-remove-var.xml Fri Jun 15 00:14:21 2007 @@ -1,28 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.18 --> - <refentry id="function.shm-remove-var"> - <refnamediv> - <refname>shm_remove_var</refname> - <refpurpose>Removes a variable from shared memory - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_remove_var</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> - </methodsynopsis> - <para> - Removes a variable with a given <parameter>variable_key</parameter> - and frees the occupied memory. - </para> - <para> - See also <function>shm_remove</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-remove-var"> + <refnamediv> + <refname>shm_remove_var</refname> + <refpurpose>Removes a variable from shared memory + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_remove_var</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> + </methodsynopsis> + <para> + Removes a variable with a given <parameter>variable_key</parameter> + and frees the occupied memory. + </para> + <para> + See also <function>shm_remove</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-remove.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-remove.xml diff -u phpdoc/en/reference/sem/functions/shm-remove.xml:1.5 phpdoc/en/reference/sem/functions/shm-remove.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-remove.xml:1.5 Fri Jun 24 09:11:46 2005 +++ phpdoc/en/reference/sem/functions/shm-remove.xml Fri Jun 15 00:14:21 2007 @@ -1,26 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.shm-remove"> - <refnamediv> - <refname>shm_remove</refname> - <refpurpose>Removes shared memory from Unix systems</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_remove</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <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>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-remove"> + <refnamediv> + <refname>shm_remove</refname> + <refpurpose>Removes shared memory from Unix systems</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_remove</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <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>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/ftok.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/ftok.xml diff -u phpdoc/en/reference/sem/functions/ftok.xml:1.5 phpdoc/en/reference/sem/functions/ftok.xml:1.6 --- phpdoc/en/reference/sem/functions/ftok.xml:1.5 Sun Oct 15 04:17:56 2006 +++ phpdoc/en/reference/sem/functions/ftok.xml Fri Jun 15 00:14:21 2007 @@ -1,37 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id='function.ftok'> - <refnamediv> - <refname>ftok</refname> - <refpurpose> - Convert a pathname and a project identifier to a System V IPC key - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ftok</methodname> - <methodparam><type>string</type><parameter>pathname</parameter></methodparam> - <methodparam><type>string</type><parameter>proj</parameter></methodparam> - </methodsynopsis> - <para> - The function converts the <parameter>pathname</parameter> of an existing - accessible file and a project identifier (<parameter>proj</parameter>) - into a - <literal>integer</literal> for use with for example - <function>shmop_open</function> and other System V IPC keys. The - <parameter>proj</parameter> parameter must be a one character string. - </para> - <para> - On success the return value will be the created key value, otherwise - <literal>-1</literal> is returned. - </para> - <para> - See also <function>shmop_open</function> and <function>sem_get</function>. - </para> - </refsect1> - </refentry> +<refentry id='function.ftok'> + <refnamediv> + <refname>ftok</refname> + <refpurpose>Convert a pathname and a project identifier to a System V IPC key</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ftok</methodname> + <methodparam><type>string</type><parameter>pathname</parameter></methodparam> + <methodparam><type>string</type><parameter>proj</parameter></methodparam> + </methodsynopsis> + <para> + The function converts the <parameter>pathname</parameter> of an existing + accessible file and a project identifier (<parameter>proj</parameter>) + into a + <literal>integer</literal> for use with for example + <function>shmop_open</function> and other System V IPC keys. The + <parameter>proj</parameter> parameter must be a one character string. + </para> + <para> + On success the return value will be the created key value, otherwise + <literal>-1</literal> is returned. + </para> + <para> + See also <function>shmop_open</function> and <function>sem_get</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-get-queue.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-get-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-get-queue.xml:1.3 phpdoc/en/reference/sem/functions/msg-get-queue.xml:1.4 --- phpdoc/en/reference/sem/functions/msg-get-queue.xml:1.3 Sun Apr 25 10:08:54 2004 +++ phpdoc/en/reference/sem/functions/msg-get-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,39 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.msg-get-queue"> - <refnamediv> - <refname>msg_get_queue</refname> - <refpurpose> - Create or attach to a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>msg_get_queue</methodname> - <methodparam><type>int</type><parameter>key</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>perms</parameter></methodparam> - </methodsynopsis> - <para> - <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 - the optional <parameter>perms</parameter> (default: 0666). - A second call to <function>msg_get_queue</function> for the same - <parameter>key</parameter> will return a different message queue - identifier, but both identifiers access the same underlying message - queue. - If the message queue already exists, the <parameter>perms</parameter> - will be ignored. - </para> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, <function>msg_send</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.msg-get-queue"> + <refnamediv> + <refname>msg_get_queue</refname> + <refpurpose>Create or attach to a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>msg_get_queue</methodname> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>perms</parameter></methodparam> + </methodsynopsis> + <para> + <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 + the optional <parameter>perms</parameter> (default: 0666). + A second call to <function>msg_get_queue</function> for the same + <parameter>key</parameter> will return a different message queue + identifier, but both identifiers access the same underlying message + queue. + If the message queue already exists, the <parameter>perms</parameter> + will be ignored. + </para> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, <function>msg_send</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-receive.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-receive.xml diff -u phpdoc/en/reference/sem/functions/msg-receive.xml:1.8 phpdoc/en/reference/sem/functions/msg-receive.xml:1.9 --- phpdoc/en/reference/sem/functions/msg-receive.xml:1.8 Tue Nov 14 12:11:02 2006 +++ phpdoc/en/reference/sem/functions/msg-receive.xml Fri Jun 15 00:14:21 2007 @@ -1,117 +1,115 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> - <refentry id="function.msg-receive"> - <refnamediv> - <refname>msg_receive</refname> - <refpurpose> - Receive a message from a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_receive</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - <methodparam><type>int</type><parameter>desiredmsgtype</parameter></methodparam> - <methodparam><type>int</type><parameter role="reference">msgtype</parameter></methodparam> - <methodparam><type>int</type><parameter>maxsize</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">message</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>unserialize</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> - </methodsynopsis> - <para> - <function>msg_receive</function> will receive the first message from the - specified <parameter>queue</parameter> of the type specified by - <parameter>desiredmsgtype</parameter>. - The type of the message that was received will be stored in - <parameter>msgtype</parameter>. - The maximum size of message to be accepted is specified by the - <parameter>maxsize</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). - The received message will be stored in <parameter>message</parameter>, - unless there were errors receiving the message, in which case the - optional <parameter>errorcode</parameter> will be set to the value of the - system errno variable to help you identify the cause. - </para> - <para> - If <parameter>desiredmsgtype</parameter> is 0, the message from the front - of the queue is returned. If <parameter>desiredmsgtype</parameter> is - greater than 0, then the first message of that type is returned. - If <parameter>desiredmsgtype</parameter> is less than 0, the first - message on the queue with the lowest type less than or equal to the - 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 <constant>MSG_IPC_NOWAIT</constant> in the - <parameter>flags</parameter> parameter. - </para> - <para> - <parameter>unserialize</parameter> defaults to &true;; if it is 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. - If <parameter>unserialize</parameter> is &false;, the message will be - returned as a binary-safe string. - </para> - <para> - The optional <parameter>flags</parameter> allows you to pass flags to the - low-level msgrcv system call. It defaults to 0, but you may specify one - or more of the following values (by adding or ORing them together). - <table> - <title>Flag values for msg_receive</title> - <tgroup cols="2"> - <tbody> - <row> - <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 - corresponding to <constant>MSG_ENOMSG</constant>. - </entry> - </row> - <row> - <entry><constant>MSG_EXCEPT</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><constant>MSG_NOERROR</constant></entry> - <entry> - If the message is longer than <parameter>maxsize</parameter>, - setting this flag will truncate the message to - <parameter>maxsize</parameter> and will not signal an error. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - 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> - <para> - <function>msg_receive</function> returns &true; on success or &false; on - failure. If the function fails, the optional - <parameter>errorcode</parameter> will be set to the value of the system - errno variable. - </para> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_send</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.9 $ --> +<refentry id="function.msg-receive"> + <refnamediv> + <refname>msg_receive</refname> + <refpurpose>Receive a message from a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_receive</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + <methodparam><type>int</type><parameter>desiredmsgtype</parameter></methodparam> + <methodparam><type>int</type><parameter role="reference">msgtype</parameter></methodparam> + <methodparam><type>int</type><parameter>maxsize</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">message</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>unserialize</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> + </methodsynopsis> + <para> + <function>msg_receive</function> will receive the first message from the + specified <parameter>queue</parameter> of the type specified by + <parameter>desiredmsgtype</parameter>. + The type of the message that was received will be stored in + <parameter>msgtype</parameter>. + The maximum size of message to be accepted is specified by the + <parameter>maxsize</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). + The received message will be stored in <parameter>message</parameter>, + unless there were errors receiving the message, in which case the + optional <parameter>errorcode</parameter> will be set to the value of the + system errno variable to help you identify the cause. + </para> + <para> + If <parameter>desiredmsgtype</parameter> is 0, the message from the front + of the queue is returned. If <parameter>desiredmsgtype</parameter> is + greater than 0, then the first message of that type is returned. + If <parameter>desiredmsgtype</parameter> is less than 0, the first + message on the queue with the lowest type less than or equal to the + 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 <constant>MSG_IPC_NOWAIT</constant> in the + <parameter>flags</parameter> parameter. + </para> + <para> + <parameter>unserialize</parameter> defaults to &true;; if it is 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. + If <parameter>unserialize</parameter> is &false;, the message will be + returned as a binary-safe string. + </para> + <para> + The optional <parameter>flags</parameter> allows you to pass flags to the + low-level msgrcv system call. It defaults to 0, but you may specify one + or more of the following values (by adding or ORing them together). + <table> + <title>Flag values for msg_receive</title> + <tgroup cols="2"> + <tbody> + <row> + <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 + corresponding to <constant>MSG_ENOMSG</constant>. + </entry> + </row> + <row> + <entry><constant>MSG_EXCEPT</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><constant>MSG_NOERROR</constant></entry> + <entry> + If the message is longer than <parameter>maxsize</parameter>, + setting this flag will truncate the message to + <parameter>maxsize</parameter> and will not signal an error. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + 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> + <para> + <function>msg_receive</function> returns &true; on success or &false; on + failure. If the function fails, the optional + <parameter>errorcode</parameter> will be set to the value of the system + errno variable. + </para> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_send</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-remove-queue.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-remove-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-remove-queue.xml:1.4 phpdoc/en/reference/sem/functions/msg-remove-queue.xml:1.5 --- phpdoc/en/reference/sem/functions/msg-remove-queue.xml:1.4 Fri Apr 22 15:39:28 2005 +++ phpdoc/en/reference/sem/functions/msg-remove-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,32 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.msg-remove-queue"> - <refnamediv> - <refname>msg_remove_queue</refname> - <refpurpose> - Destroy a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_remove_queue</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - </methodsynopsis> - <para> - <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> - <para> - See also <function>msg_get_queue</function>, - <function>msg_receive</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id="function.msg-remove-queue"> + <refnamediv> + <refname>msg_remove_queue</refname> + <refpurpose>Destroy a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_remove_queue</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + </methodsynopsis> + <para> + <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> + <para> + See also <function>msg_get_queue</function>, + <function>msg_receive</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-send.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-send.xml diff -u phpdoc/en/reference/sem/functions/msg-send.xml:1.7 phpdoc/en/reference/sem/functions/msg-send.xml:1.8 --- phpdoc/en/reference/sem/functions/msg-send.xml:1.7 Tue Nov 14 12:11:02 2006 +++ phpdoc/en/reference/sem/functions/msg-send.xml Fri Jun 15 00:14:21 2007 @@ -1,62 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> - <refentry id="function.msg-send"> - <refnamediv> - <refname>msg_send</refname> - <refpurpose> - Send a message to a message queue - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_send</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - <methodparam><type>int</type><parameter>msgtype</parameter></methodparam> - <methodparam><type>mixed</type><parameter>message</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>serialize</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>blocking</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> - </methodsynopsis> - <para> - <function>msg_send</function> sends a <parameter>message</parameter> of type - <parameter>msgtype</parameter> (which MUST be greater than 0) to - the message queue specified by <parameter>queue</parameter>. - </para> - <para> - 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. - This is called blocking; you can prevent blocking by setting the - optional <parameter>blocking</parameter> parameter to &false;, in which - case <function>msg_send</function> will immediately return &false; if the - message is too big for the queue, and set the optional - <parameter>errorcode</parameter> to <constant>MSG_EAGAIN</constant>, indicating that you should - try to send your message again a little later on. - </para> - <para> - 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 - serialized using the same mechanism as the session module before being - 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> - <para> - 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> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, - <function>msg_stat_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.8 $ --> +<refentry id="function.msg-send"> + <refnamediv> + <refname>msg_send</refname> + <refpurpose>Send a message to a message queue</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_send</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + <methodparam><type>int</type><parameter>msgtype</parameter></methodparam> + <methodparam><type>mixed</type><parameter>message</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>serialize</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>blocking</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter role="reference">errorcode</parameter></methodparam> + </methodsynopsis> + <para> + <function>msg_send</function> sends a <parameter>message</parameter> of type + <parameter>msgtype</parameter> (which MUST be greater than 0) to + the message queue specified by <parameter>queue</parameter>. + </para> + <para> + 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. + This is called blocking; you can prevent blocking by setting the + optional <parameter>blocking</parameter> parameter to &false;, in which + case <function>msg_send</function> will immediately return &false; if the + message is too big for the queue, and set the optional + <parameter>errorcode</parameter> to <constant>MSG_EAGAIN</constant>, indicating that you should + try to send your message again a little later on. + </para> + <para> + 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 + serialized using the same mechanism as the session module before being + 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> + <para> + 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> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, + <function>msg_stat_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-set-queue.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-set-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-set-queue.xml:1.5 phpdoc/en/reference/sem/functions/msg-set-queue.xml:1.6 --- phpdoc/en/reference/sem/functions/msg-set-queue.xml:1.5 Fri Apr 22 15:39:28 2005 +++ phpdoc/en/reference/sem/functions/msg-set-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,41 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.msg-set-queue"> - <refnamediv> - <refname>msg_set_queue</refname> - <refpurpose> - Set information in the message queue data structure - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msg_set_queue</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - <methodparam><type>array</type><parameter>data</parameter></methodparam> - </methodsynopsis> - <para> - <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. - You specify the values you require by setting the value of the keys that - you require in the <parameter>data</parameter> array. - </para> - <para> - 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> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, - <function>msg_stat_queue</function> and - <function>msg_get_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.msg-set-queue"> + <refnamediv> + <refname>msg_set_queue</refname> + <refpurpose>Set information in the message queue data structure</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msg_set_queue</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + <methodparam><type>array</type><parameter>data</parameter></methodparam> + </methodsynopsis> + <para> + <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. + You specify the values you require by setting the value of the keys that + you require in the <parameter>data</parameter> array. + </para> + <para> + 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> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, + <function>msg_stat_queue</function> and + <function>msg_get_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/msg-stat-queue.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/msg-stat-queue.xml diff -u phpdoc/en/reference/sem/functions/msg-stat-queue.xml:1.5 phpdoc/en/reference/sem/functions/msg-stat-queue.xml:1.6 --- phpdoc/en/reference/sem/functions/msg-stat-queue.xml:1.5 Fri Apr 22 15:39:28 2005 +++ phpdoc/en/reference/sem/functions/msg-stat-queue.xml Fri Jun 15 00:14:21 2007 @@ -1,104 +1,102 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.msg-stat-queue"> - <refnamediv> - <refname>msg_stat_queue</refname> - <refpurpose> - Returns information from the message queue data structure - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>msg_stat_queue</methodname> - <methodparam><type>resource</type><parameter>queue</parameter></methodparam> - </methodsynopsis> - <para> - <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> - <para> - The return value is an array whose keys and values have the following - meanings: - <table> - <title>Array structure for msg_stat_queue</title> - <tgroup cols="2"> - <tbody> - <row> - <entry><literal>msg_perm.uid</literal></entry> - <entry> - The uid of the owner of the queue. - </entry> - </row> - <row> - <entry><literal>msg_perm.gid</literal></entry> - <entry> - The gid of the owner of the queue. - </entry> - </row> - <row> - <entry><literal>msg_perm.mode</literal></entry> - <entry> - The file access mode of the queue. - </entry> - </row> - <row> - <entry><literal>msg_stime</literal></entry> - <entry> - The time that the last message was sent to the queue. - </entry> - </row> - <row> - <entry><literal>msg_rtime</literal></entry> - <entry> - The time that the last message was received from the queue. - </entry> - </row> - <row> - <entry><literal>msg_ctime</literal></entry> - <entry> - The time that the queue was last changed. - </entry> - </row> - <row> - <entry><literal>msg_qnum</literal></entry> - <entry> - The number of messages waiting to be read from the queue. - </entry> - </row> - <row> - <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><literal>msg_lspid</literal></entry> - <entry> - The pid of the process that sent the last message to the queue. - </entry> - </row> - <row> - <entry><literal>msg_lrpid</literal></entry> - <entry> - The pid of the process that received the last message from the queue. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - See also <function>msg_remove_queue</function>, - <function>msg_receive</function>, - <function>msg_get_queue</function> and - <function>msg_set_queue</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.msg-stat-queue"> + <refnamediv> + <refname>msg_stat_queue</refname> + <refpurpose>Returns information from the message queue data structure</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>msg_stat_queue</methodname> + <methodparam><type>resource</type><parameter>queue</parameter></methodparam> + </methodsynopsis> + <para> + <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> + <para> + The return value is an array whose keys and values have the following + meanings: + <table> + <title>Array structure for msg_stat_queue</title> + <tgroup cols="2"> + <tbody> + <row> + <entry><literal>msg_perm.uid</literal></entry> + <entry> + The uid of the owner of the queue. + </entry> + </row> + <row> + <entry><literal>msg_perm.gid</literal></entry> + <entry> + The gid of the owner of the queue. + </entry> + </row> + <row> + <entry><literal>msg_perm.mode</literal></entry> + <entry> + The file access mode of the queue. + </entry> + </row> + <row> + <entry><literal>msg_stime</literal></entry> + <entry> + The time that the last message was sent to the queue. + </entry> + </row> + <row> + <entry><literal>msg_rtime</literal></entry> + <entry> + The time that the last message was received from the queue. + </entry> + </row> + <row> + <entry><literal>msg_ctime</literal></entry> + <entry> + The time that the queue was last changed. + </entry> + </row> + <row> + <entry><literal>msg_qnum</literal></entry> + <entry> + The number of messages waiting to be read from the queue. + </entry> + </row> + <row> + <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><literal>msg_lspid</literal></entry> + <entry> + The pid of the process that sent the last message to the queue. + </entry> + </row> + <row> + <entry><literal>msg_lrpid</literal></entry> + <entry> + The pid of the process that received the last message from the queue. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + See also <function>msg_remove_queue</function>, + <function>msg_receive</function>, + <function>msg_get_queue</function> and + <function>msg_set_queue</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-acquire.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-acquire.xml diff -u phpdoc/en/reference/sem/functions/sem-acquire.xml:1.6 phpdoc/en/reference/sem/functions/sem-acquire.xml:1.7 --- phpdoc/en/reference/sem/functions/sem-acquire.xml:1.6 Thu May 4 09:00:31 2006 +++ phpdoc/en/reference/sem/functions/sem-acquire.xml Fri Jun 15 00:14:21 2007 @@ -1,41 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.sem-acquire"> - <refnamediv> - <refname>sem_acquire</refname> - <refpurpose>Acquire a semaphore</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>sem_acquire</methodname> - <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <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 maximum number - of semaphore to be exceeded. - <parameter>sem_identifier</parameter> is a semaphore resource, - obtained from <function>sem_get</function>. - </para> - <para> - &return.success; - </para> - <para> - 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> - <para> - See also - <function>sem_get</function>, and - <function>sem_release</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-acquire"> + <refnamediv> + <refname>sem_acquire</refname> + <refpurpose>Acquire a semaphore</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>sem_acquire</methodname> + <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <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 maximum number + of semaphore to be exceeded. + <parameter>sem_identifier</parameter> is a semaphore resource, + obtained from <function>sem_get</function>. + </para> + <para> + &return.success; + </para> + <para> + 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> + <para> + See also + <function>sem_get</function>, and + <function>sem_release</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-get.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-get.xml diff -u phpdoc/en/reference/sem/functions/sem-get.xml:1.9 phpdoc/en/reference/sem/functions/sem-get.xml:1.10 --- phpdoc/en/reference/sem/functions/sem-get.xml:1.9 Thu Aug 12 18:11:59 2004 +++ phpdoc/en/reference/sem/functions/sem-get.xml Fri Jun 15 00:14:21 2007 @@ -1,49 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.sem-get"> - <refnamediv> - <refname>sem_get</refname> - <refpurpose>Get a semaphore id</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>sem_get</methodname> - <methodparam><type>int</type><parameter>key</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>max_acquire</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>perm</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>auto_release</parameter></methodparam> - </methodsynopsis> - <para> - <function>sem_get</function> returns an id that can be used to - 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> - <para> - Optional parameter <parameter>auto_release</parameter> specifies if the - semaphore should be automatically released on request shutdown. - It is available since PHP 4.3.0. - </para> - <para> - Returns a positive semaphore identifier on success, or &false; on - error. - </para> - <para> - 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> - See also <function>sem_acquire</function>, - <function>sem_release</function>, and <function>ftok</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-get"> + <refnamediv> + <refname>sem_get</refname> + <refpurpose>Get a semaphore id</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>sem_get</methodname> + <methodparam><type>int</type><parameter>key</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>max_acquire</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>perm</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>auto_release</parameter></methodparam> + </methodsynopsis> + <para> + <function>sem_get</function> returns an id that can be used to + 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> + <para> + Optional parameter <parameter>auto_release</parameter> specifies if the + semaphore should be automatically released on request shutdown. + It is available since PHP 4.3.0. + </para> + <para> + Returns a positive semaphore identifier on success, or &false; on + error. + </para> + <para> + 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> + See also <function>sem_acquire</function>, + <function>sem_release</function>, and <function>ftok</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-release.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-release.xml diff -u phpdoc/en/reference/sem/functions/sem-release.xml:1.5 phpdoc/en/reference/sem/functions/sem-release.xml:1.6 --- phpdoc/en/reference/sem/functions/sem-release.xml:1.5 Sun Apr 25 10:14:51 2004 +++ phpdoc/en/reference/sem/functions/sem-release.xml Fri Jun 15 00:14:21 2007 @@ -1,36 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.sem-release"> - <refnamediv> - <refname>sem_release</refname> - <refpurpose>Release a semaphore</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>sem_release</methodname> - <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>sem_release</function> releases the semaphore if it - is currently acquired by the calling process, otherwise - a warning is generated. - </para> - <para> - &return.success; - </para> - <para> - After releasing the semaphore, <function>sem_acquire</function> - may be called to re-acquire it. - </para> - <para> - See also - <function>sem_get</function> and - <function>sem_acquire</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-release"> + <refnamediv> + <refname>sem_release</refname> + <refpurpose>Release a semaphore</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>sem_release</methodname> + <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>sem_release</function> releases the semaphore if it + is currently acquired by the calling process, otherwise + a warning is generated. + </para> + <para> + &return.success; + </para> + <para> + After releasing the semaphore, <function>sem_acquire</function> + may be called to re-acquire it. + </para> + <para> + See also + <function>sem_get</function> and + <function>sem_acquire</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/sem-remove.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/sem-remove.xml diff -u phpdoc/en/reference/sem/functions/sem-remove.xml:1.5 phpdoc/en/reference/sem/functions/sem-remove.xml:1.6 --- phpdoc/en/reference/sem/functions/sem-remove.xml:1.5 Sun Apr 25 10:14:51 2004 +++ phpdoc/en/reference/sem/functions/sem-remove.xml Fri Jun 15 00:14:21 2007 @@ -1,36 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.7 --> - <refentry id="function.sem-remove"> - <refnamediv> - <refname>sem_remove</refname> - <refpurpose>Remove a semaphore</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>sem_remove</methodname> - <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>sem_remove</function> removes the semaphore - <parameter>sem_identifier</parameter> if it - has been created by <function>sem_get</function>, - otherwise generates a warning. - </para> - <para> - &return.success; - </para> - <para> - After removing the semaphore, it is no more accessible. - </para> - <para> - See also <function>sem_get</function>, - <function>sem_release</function> and - <function>sem_acquire</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.sem-remove"> + <refnamediv> + <refname>sem_remove</refname> + <refpurpose>Remove a semaphore</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>sem_remove</methodname> + <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>sem_remove</function> removes the semaphore + <parameter>sem_identifier</parameter> if it + has been created by <function>sem_get</function>, + otherwise generates a warning. + </para> + <para> + &return.success; + </para> + <para> + After removing the semaphore, it is no more accessible. + </para> + <para> + See also <function>sem_get</function>, + <function>sem_release</function> and + <function>sem_acquire</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-attach.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-attach.xml diff -u phpdoc/en/reference/sem/functions/shm-attach.xml:1.8 phpdoc/en/reference/sem/functions/shm-attach.xml:1.9 --- phpdoc/en/reference/sem/functions/shm-attach.xml:1.8 Sat Feb 3 12:38:30 2007 +++ phpdoc/en/reference/sem/functions/shm-attach.xml Fri Jun 15 00:14:21 2007 @@ -1,39 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.shm-attach"> - <refnamediv> - <refname>shm_attach</refname> - <refpurpose>Creates or open a shared memory segment</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</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></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> - (default: sysvshm.init_mem in the &php.ini;, otherwise - 10000 bytes) and the optional perm-bits <parameter>perm</parameter> - (default: 0666). - </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> - <para> - See also <function>ftok</function>, and <function>shm_detach</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-attach"> + <refnamediv> + <refname>shm_attach</refname> + <refpurpose>Creates or open a shared memory segment</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</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></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> + (default: sysvshm.init_mem in the &php.ini;, otherwise + 10000 bytes) and the optional perm-bits <parameter>perm</parameter> + (default: 0666). + </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> + <para> + See also <function>ftok</function>, and <function>shm_detach</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-detach.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-detach.xml diff -u phpdoc/en/reference/sem/functions/shm-detach.xml:1.5 phpdoc/en/reference/sem/functions/shm-detach.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-detach.xml:1.5 Sun Apr 25 10:20:20 2004 +++ phpdoc/en/reference/sem/functions/shm-detach.xml Fri Jun 15 00:14:21 2007 @@ -1,32 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.shm-detach"> - <refnamediv> - <refname>shm_detach</refname> - <refpurpose>Disconnects from shared memory segment</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_detach</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>shm_detach</function> disconnects from the shared - memory given by the <parameter>shm_identifier</parameter> created - by <function>shm_attach</function>. Remember, that shared memory - still exist in the Unix system and the data is still present. - </para> - <para> - <function>shm_detach</function> always returns &true;. - </para> - <para> - See also <function>shm_attach</function>, <function>shm_remove</function>, - and <function>shm_remove_var</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-detach"> + <refnamediv> + <refname>shm_detach</refname> + <refpurpose>Disconnects from shared memory segment</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_detach</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>shm_detach</function> disconnects from the shared + memory given by the <parameter>shm_identifier</parameter> created + by <function>shm_attach</function>. Remember, that shared memory + still exist in the Unix system and the data is still present. + </para> + <para> + <function>shm_detach</function> always returns &true;. + </para> + <para> + See also <function>shm_attach</function>, <function>shm_remove</function>, + and <function>shm_remove_var</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-get-var.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-get-var.xml diff -u phpdoc/en/reference/sem/functions/shm-get-var.xml:1.4 phpdoc/en/reference/sem/functions/shm-get-var.xml:1.5 --- phpdoc/en/reference/sem/functions/shm-get-var.xml:1.4 Wed Apr 28 11:39:18 2004 +++ phpdoc/en/reference/sem/functions/shm-get-var.xml Fri Jun 15 00:14:21 2007 @@ -1,28 +1,28 @@ <?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-get-var"> - <refnamediv> - <refname>shm_get_var</refname> - <refpurpose>Returns a variable from shared memory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>shm_get_var</methodname> - <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>, 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> - </refentry> +<refentry id="function.shm-get-var"> + <refnamediv> + <refname>shm_get_var</refname> + <refpurpose>Returns a variable from shared memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>shm_get_var</methodname> + <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>, 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> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-put-var.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-put-var.xml diff -u phpdoc/en/reference/sem/functions/shm-put-var.xml:1.5 phpdoc/en/reference/sem/functions/shm-put-var.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-put-var.xml:1.5 Wed Apr 28 11:39:18 2004 +++ phpdoc/en/reference/sem/functions/shm-put-var.xml Fri Jun 15 00:14:21 2007 @@ -1,38 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- 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> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_put_var</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> - <methodparam><type>mixed</type><parameter>variable</parameter></methodparam> - </methodsynopsis> - <para> - <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; - </para> - <para> - Warnings (<literal>E_WARNING</literal> level) will be issued if - <parameter>shm_identifier</parameter> is not a valid SysV shared memory - index or if there was not enough shared memory remaining to complete your - request. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-put-var"> + <refnamediv> + <refname>shm_put_var</refname> + <refpurpose>Inserts or updates a variable in shared memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_put_var</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> + <methodparam><type>mixed</type><parameter>variable</parameter></methodparam> + </methodsynopsis> + <para> + <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; + </para> + <para> + Warnings (<literal>E_WARNING</literal> level) will be issued if + <parameter>shm_identifier</parameter> is not a valid SysV shared memory + index or if there was not enough shared memory remaining to complete your + request. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-remove-var.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-remove-var.xml diff -u phpdoc/en/reference/sem/functions/shm-remove-var.xml:1.5 phpdoc/en/reference/sem/functions/shm-remove-var.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-remove-var.xml:1.5 Fri Jun 24 09:11:46 2005 +++ phpdoc/en/reference/sem/functions/shm-remove-var.xml Fri Jun 15 00:14:21 2007 @@ -1,28 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.18 --> - <refentry id="function.shm-remove-var"> - <refnamediv> - <refname>shm_remove_var</refname> - <refpurpose>Removes a variable from shared memory - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_remove_var</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> - </methodsynopsis> - <para> - Removes a variable with a given <parameter>variable_key</parameter> - and frees the occupied memory. - </para> - <para> - See also <function>shm_remove</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-remove-var"> + <refnamediv> + <refname>shm_remove_var</refname> + <refpurpose>Removes a variable from shared memory + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_remove_var</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>variable_key</parameter></methodparam> + </methodsynopsis> + <para> + Removes a variable with a given <parameter>variable_key</parameter> + and frees the occupied memory. + </para> + <para> + See also <function>shm_remove</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sem/functions/shm-remove.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sem/functions/shm-remove.xml diff -u phpdoc/en/reference/sem/functions/shm-remove.xml:1.5 phpdoc/en/reference/sem/functions/shm-remove.xml:1.6 --- phpdoc/en/reference/sem/functions/shm-remove.xml:1.5 Fri Jun 24 09:11:46 2005 +++ phpdoc/en/reference/sem/functions/shm-remove.xml Fri Jun 15 00:14:21 2007 @@ -1,26 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 --> - <refentry id="function.shm-remove"> - <refnamediv> - <refname>shm_remove</refname> - <refpurpose>Removes shared memory from Unix systems</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>shm_remove</methodname> - <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <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>. - </para> - </refsect1> - </refentry> +<refentry id="function.shm-remove"> + <refnamediv> + <refname>shm_remove</refname> + <refpurpose>Removes shared memory from Unix systems</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>shm_remove</methodname> + <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <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>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: