<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Acquires a lock on buffer</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.freeze.html">EventBuffer::freeze</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbuffer.prepend.html">EventBuffer::prepend</a></div>
<div class="up"><a href="class.eventbuffer.html">EventBuffer</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="eventbuffer.lock" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventBuffer::lock</h1>
<p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">EventBuffer::lock</span> — <span class="dc-title">Acquires a lock on buffer</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventbuffer.lock-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type"><span class="type void">void</span></span>
<span class="methodname"><strong>EventBuffer::lock</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Acquires a lock on buffer. Can be used in pair with
<span class="methodname"><a href="eventbuffer.unlock.html" class="methodname">EventBuffer::unlock()</a></span>
to make a set of operations atomic, i.e. thread-safe. Note, it is not
needed to lock buffers for
<em class="emphasis">individual</em>
operations. When locking is enabled(see
<span class="methodname"><a href="eventbuffer.enablelocking.html" class="methodname">EventBuffer::enableLocking()</a></span>
), individual operations on event buffers are already atomic.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-eventbuffer.lock-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventbuffer.lock-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success. Otherwise <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-eventbuffer.lock-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">
<span class="methodname"><a href="eventbuffer.unlock.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::unlock()</a> - Releases lock acquired by EventBuffer::lock</span>
</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.freeze.html">EventBuffer::freeze</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbuffer.prepend.html">EventBuffer::prepend</a></div>
<div class="up"><a href="class.eventbuffer.html">EventBuffer</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
