<!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>Resets a manual event</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="syncevent.fire.html">SyncEvent::fire</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncevent.wait.html">SyncEvent::wait</a></div>
<div class="up"><a href="class.syncevent.html">SyncEvent</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="syncevent.reset" class="refentry">
<div class="refnamediv">
<h1 class="refname">SyncEvent::reset</h1>
<p class="verinfo">(PECL sync >= 1.0.0)</p><p class="refpurpose"><span class="refname">SyncEvent::reset</span> — <span class="dc-title">Resets a manual event</span></p>
</div>
<div class="refsect1 description" id="refsect1-syncevent.reset-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SyncEvent::reset</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Resets a SyncEvent object that has been fired/set. Only valid for manual event objects.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-syncevent.reset-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-syncevent.reset-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A boolean value of TRUE if the object was successfully reset, FALSE otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-syncevent.reset-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4599">
<p><strong>Example #1 <span class="function"><strong>SyncEvent::reset()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// In a web application:<br /></span><span style="color: #0000BB">$event </span><span style="color: #007700">= new </span><span style="color: #0000BB">SyncEvent</span><span style="color: #007700">(</span><span style="color: #DD0000">"DemoApplication"</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$event</span><span style="color: #007700">-></span><span style="color: #0000BB">wait</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// In a cron job:<br /></span><span style="color: #0000BB">$event </span><span style="color: #007700">= new </span><span style="color: #0000BB">SyncEvent</span><span style="color: #007700">(</span><span style="color: #DD0000">"DemoApplication"</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$event</span><span style="color: #007700">-></span><span style="color: #0000BB">reset</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">/* ... Do some maintenance task(s) ... */<br /></span><span style="color: #0000BB">$event</span><span style="color: #007700">-></span><span style="color: #0000BB">fire</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-syncevent.reset-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="syncevent.fire.html" class="methodname" rel="rdfs-seeAlso">SyncEvent::fire()</a> - Fires/sets the event</span></li>
<li class="member"><span class="methodname"><strong>SyncEvent::reset()</strong></span></li>
<li class="member"><span class="methodname"><a href="syncevent.wait.html" class="methodname" rel="rdfs-seeAlso">SyncEvent::wait()</a> - Waits for the event to be fired/set</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="syncevent.fire.html">SyncEvent::fire</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncevent.wait.html">SyncEvent::wait</a></div>
<div class="up"><a href="class.syncevent.html">SyncEvent</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
