<!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>Adjusts read and/or write watermarks</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbufferevent.settimeouts.html">EventBufferEvent::setTimeouts</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbufferevent.sslerror.html">EventBufferEvent::sslError</a></div>
<div class="up"><a href="class.eventbufferevent.html">EventBufferEvent</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="eventbufferevent.setwatermark" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventBufferEvent::setWatermark</h1>
<p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">EventBufferEvent::setWatermark</span> — <span class="dc-title">Adjusts read and/or write watermarks</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventbufferevent.setwatermark-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>EventBufferEvent::setWatermark</strong></span>
( <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$events</code>
</span>
, <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$lowmark</code>
</span>
, <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$highmark</code>
</span>
)</div>
<p class="para rdfs-comment">
Adjusts the read watermarks, the write
<em class="emphasis">watermarks</em>
, or both, of a single buffer event.
</p>
<p class="para">
A buffer event watermark is an edge, a value specifying number of bytes to
be read or written before callback is invoked. By default every read/write
event triggers a callback invokation. See
<a href="http://www.wangafu.net/~nickm/libevent-book/Ref6_bufferevent.html#_callbacks_and_watermarks" class="link external">» Fast
portable non-blocking network programming with Libevent: Callbacks and watermarks</a>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-eventbufferevent.setwatermark-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">events</code></em>
</span>
<dd>
<p class="para">
Bitmask of
<strong><code>Event::READ</code></strong>
,
<strong><code>Event::WRITE</code></strong>
, or both.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">lowmark</code></em>
</span>
<dd>
<p class="para">
Minimum watermark value.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">highmark</code></em>
</span>
<dd>
<p class="para">
Maximum watermark value.
<strong><code>0</code></strong>
means "unlimited".
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventbufferevent.setwatermark-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbufferevent.settimeouts.html">EventBufferEvent::setTimeouts</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbufferevent.sslerror.html">EventBufferEvent::sslError</a></div>
<div class="up"><a href="class.eventbufferevent.html">EventBufferEvent</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
