Source of: /manual/en/function.sem-acquire.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sem.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.sem-acquire.php',
1 => 'sem_acquire',
),
'up' =>
array (
0 => 'ref.sem.php',
1 => 'Semaphore Functions',
),
'prev' =>
array (
0 => 'function.msg-stat-queue.php',
1 => 'msg_stat_queue',
),
'next' =>
array (
0 => 'function.sem-get.php',
1 => 'sem_get',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.sem-acquire" class="refentry">
<div class="refnamediv">
<h1 class="refname">sem_acquire</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">sem_acquire</span> — <span class="dc-title">Acquire a semaphore</span></p>
</div>
<a name="function.sem-acquire.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>sem_acquire</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$sem_identifier</tt></span>
)</div>
<p class="para rdfs-comment">
<b>sem_acquire()</b> 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.
</p>
<p class="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.
</p>
</div>
<a name="function.sem-acquire.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">sem_identifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
<i><tt class="parameter">sem_identifier</tt></i>
is a semaphore resource,
obtained from <a href="function.sem-get.php" class="function">sem_get()</a>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.sem-acquire.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.sem-acquire.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.sem-get.php" class="function" rel="rdfs-seeAlso">sem_get()</a> - Get a semaphore id</li>
<li class="member"><a href="function.sem-release.php" class="function" rel="rdfs-seeAlso">sem_release()</a> - Release a semaphore</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
