mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
3ac72a29ba
-- Provided by anonymous 62063 (me@stephencoakley.com) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337493 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3.1 KiB
XML
119 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.sem-acquire">
|
|
<refnamediv>
|
|
<refname>sem_acquire</refname>
|
|
<refpurpose>Acquire a semaphore</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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> 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
|
|
explicitly released will be released automatically and a warning will be
|
|
generated.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>sem_identifier</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>sem_identifier</parameter> is a semaphore resource,
|
|
obtained from <function>sem_get</function>.
|
|
</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>
|
|
<simplelist>
|
|
<member><function>sem_get</function></member>
|
|
<member><function>sem_release</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|