<!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>Clear watcher pending status</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.evwatcher.html">EvWatcher</a></div>
<div class="next" style="text-align: right; float: right;"><a href="evwatcher.construct.html">EvWatcher::__construct</a></div>
<div class="up"><a href="class.evwatcher.html">EvWatcher</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="evwatcher.clear" class="refentry">
<div class="refnamediv">
<h1 class="refname">EvWatcher::clear</h1>
<p class="verinfo">(PECL ev >= 0.2.0)</p><p class="refpurpose"><span class="refname">EvWatcher::clear</span> — <span class="dc-title">Clear watcher pending status</span></p>
</div>
<div class="refsect1 description" id="refsect1-evwatcher.clear-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">int</span>
<span class="methodname"><strong>EvWatcher::clear</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
If the watcher is pending, this method clears its
<var class="varname"><var class="varname">pending</var></var>
status and returns its
<var class="varname"><var class="varname">revents</var></var>
bitset(as if its callback was invoked). If the watcher isn't pending
it does nothing and returns
<strong><code>0</code></strong>
.
</p>
<p class="para">
Sometimes it can be useful to "poll" a watcher instead of waiting for its
callback to be invoked, which can be accomplished with this function.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-evwatcher.clear-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-evwatcher.clear-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
In case if the watcher is pending, returns
<var class="varname"><var class="varname">revents</var></var>
bitset as if the
<a href="ev.watcher-callbacks.html" class="link">watcher callback</a>
had been invoked. Otherwise returns
<strong><code>0</code></strong>
.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.evwatcher.html">EvWatcher</a></div>
<div class="next" style="text-align: right; float: right;"><a href="evwatcher.construct.html">EvWatcher::__construct</a></div>
<div class="up"><a href="class.evwatcher.html">EvWatcher</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
