<!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>Add an event to the set of monitored events</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.libevent.html">Libevent Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.event-base-free.html">event_base_free</a></div> <div class="up"><a href="ref.libevent.html">Libevent Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.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">Add an event to the set of monitored events</span></p> </div> <div class="refsect1 description" id="refsect1-function.event-add-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><a href="event.add.html" class="methodname">event_add</a></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$event</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code><span class="initializer"> = -1</span></span> ] )</div> <p class="para rdfs-comment"> <span class="function"><a href="event.add.html" class="function">event_add()</a></span> schedules the execution of the <em><code class="parameter">event</code></em> when the event specified in <span class="function"><a href="event.set.html" class="function">event_set()</a></span> occurs or in at least the time specified by the <em><code class="parameter">timeout</code></em> argument. If <em><code class="parameter">timeout</code></em> was not specified, not timeout is set. The <em><code class="parameter">event</code></em> must be already initalized by <span class="function"><a href="event.set.html" class="function">event_set()</a></span> and <span class="function"><a href="function.event-base-set.html" class="function">event_base_set()</a></span> functions. If the <em><code class="parameter">event</code></em> already has a timeout set, it is replaced by the new one. </p> </div> <div class="refsect1 parameters" id="refsect1-function.event-add-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">event</code></em></span> <dd> <p class="para"> Valid event resource. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">timeout</code></em></span> <dd> <p class="para"> Optional timeout (in microseconds). </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.event-add-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> <span class="function"><a href="event.add.html" class="function">event_add()</a></span> returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on error. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.libevent.html">Libevent Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.event-base-free.html">event_base_free</a></div> <div class="up"><a href="ref.libevent.html">Libevent Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>