svn: /phpdoc/en/trunk/reference/sem/functions/ sem-acquire.xml
| From: | Christoph Michael Becker | Date: | Sun, 16 Aug 2015 00:32:48 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/sem/functions/ sem-acquire.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-13602@lists.php.net to get a copy of this message | ||
cmb Sun, 16 Aug 2015 00:32:48 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=337493
Log:
The $nowait parameter was added in 5.6.1, but docs were never updated. Fixes #68141.
--
Provided by anonymous 62063 (me@stephencoakley.com)
Bug: https://bugs.php.net/68141 (Verified) sem_acquire
nowait argument is missing
Changed paths:
U phpdoc/en/trunk/reference/sem/functions/sem-acquire.xml
Modified: phpdoc/en/trunk/reference/sem/functions/sem-acquire.xml
===================================================================
--- phpdoc/en/trunk/reference/sem/functions/sem-acquire.xml 2015-08-15 17:37:18 UTC (rev 337492)
+++ phpdoc/en/trunk/reference/sem/functions/sem-acquire.xml 2015-08-16 00:32:48 UTC (rev 337493)
@@ -11,12 +11,13 @@
<methodsynopsis>
<type>bool</type><methodname>sem_acquire</methodname>
<methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>nowait</parameter><initializer>false</initializer></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.
+ <function>sem_acquire</function> by default blocks (if necessary) until the
+ semaphore can be acquired. A process attempting to acquire a semaphore which
+ it has already acquired will block forever if acquiring the semaphore would
+ cause its maximum number of semaphore to be exceeded.
</para>
<para>
After processing a request, any semaphores acquired by the process but not
@@ -24,7 +25,7 @@
generated.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@@ -38,17 +39,52 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>nowait</parameter></term>
+ <listitem>
+ <para>
+ Specifies if the process shouldn't wait for the semaphore to be acquired.
+ If set to <literal>true</literal>, the call will return
+ <literal>false</literal> immediately if a semaphore cannot be immediately
+ acquired.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
-
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>5.6.1</entry>
+ <entry>
+ The <parameter>$nowait</parameter> parameter was added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -58,7 +94,7 @@
</simplelist>
</para>
</refsect1>
-
+
</refentry>
<!-- Keep this comment at the end of the file