<!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>Makes event pending</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.event.html">Event</a></div>
<div class="next" style="text-align: right; float: right;"><a href="event.addsignal.html">Event::addSignal</a></div>
<div class="up"><a href="class.event.html">Event</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="event.add" class="refentry">
<div class="refnamediv">
<h1 class="refname">Event::add</h1>
<p class="verinfo">(PECL libevent >= 0.0.1)</p><p class="refpurpose"><span class="refname">Event::add</span> — <span class="dc-title">Makes event pending</span></p>
</div>
<div class="refsect1 description" id="refsect1-event.add-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>Event::add</strong></span>
([ <span class="methodparam">
<span class="type">double</span>
<code class="parameter">$timeout</code>
</span>
] )</div>
<p class="para rdfs-comment">
Marks event pending. Non-pending event will never occur, and the event
callback will never be called. In conjuction with
<span class="methodname"><a href="event.del.html" class="methodname">Event::del()</a></span>
an event could be re-scheduled by user at any time.
</p>
<p class="para">
If
<span class="methodname"><strong>Event::add()</strong></span>
is called on an already pending event, libevent will leave it pending and
re-schedule it with the given timeout(if specified). If in this case
timeout is not specified,
<span class="methodname"><strong>Event::add()</strong></span>
has no effect.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-event.add-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">timeout</code></em>
</span>
<dd>
<p class="para">
Timeout in seconds.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-event.add-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-event.add-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">
<span class="methodname"><a href="event.addsignal.html" class="methodname" rel="rdfs-seeAlso">Event::addSignal()</a> - Makes signal event pending</span>
</li>
<li class="member">
<span class="methodname"><a href="event.addtimer.html" class="methodname" rel="rdfs-seeAlso">Event::addTimer()</a> - Makes timer event pending</span>
</li>
<li class="member">
<span class="methodname"><a href="event.del.html" class="methodname" rel="rdfs-seeAlso">Event::del()</a> - Makes event non-pending</span>
</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.event.html">Event</a></div>
<div class="next" style="text-align: right; float: right;"><a href="event.addsignal.html">Event::addSignal</a></div>
<div class="up"><a href="class.event.html">Event</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
