<!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>Cancels a request</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.eio-busy.html">eio_busy</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.eio-chmod.html">eio_chmod</a></div> <div class="up"><a href="ref.eio.html">Eio Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.eio-cancel" class="refentry"> <div class="refnamediv"> <h1 class="refname">eio_cancel</h1> <p class="verinfo">(PECL eio >= 0.0.1dev)</p><p class="refpurpose"><span class="refname">eio_cancel</span> — <span class="dc-title">Cancels a request</span></p> </div> <div class="refsect1 description" id="refsect1-function.eio-cancel-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>eio_cancel</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$req</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>eio_cancel()</strong></span> cancels a request specified by <code class="parameter">req</code> </p> </div> <div class="refsect1 parameters" id="refsect1-function.eio-cancel-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">req</code></dt> <dd> <p class="para"> The request resource </p> </dd> <dt> <code class="parameter">pri</code></dt> <dd> <p class="para">The request priority: <strong><code>EIO_PRI_DEFAULT</code></strong>, <strong><code>EIO_PRI_MIN</code></strong>, <strong><code>EIO_PRI_MAX</code></strong>, or <strong><code>NULL</code></strong>. If <strong><code>NULL</code></strong> passed, <code class="parameter">pri</code> internally is set to <strong><code>EIO_PRI_DEFAULT</code></strong>. </p> </dd> <dt> <code class="parameter">callback</code></dt> <dd> <p class="para"> <code class="parameter">callback</code> function is called when the request is done. It should match the following prototype: <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"> void callback(mixed $data, int $result[, resource $req]);</span> </code></div></div> <dl> <dt> <code class="parameter">data</code></dt> <dd> <p class="para">is custom data passed to the request.</p></dd> <dt> <code class="parameter">result</code></dt> <dd> <p class="para">request-specific result value; basically, the value returned by corresponding system call.</p></dd> <dt> <code class="parameter">req</code></dt> <dd> <p class="para">is optional request resource which can be used with functions like <span class="function"><a href="function.eio-get-last-error.html" class="function">eio_get_last_error()</a></span></p></dd> </dl> </p> </dd> <dt> <code class="parameter">data</code></dt> <dd> <p class="para"> Arbitrary variable passed to <code class="parameter">callback</code>. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-function.eio-cancel-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No value is returned. </p> </div> <div class="refsect1 examples" id="refsect1-function.eio-cancel-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-4398"> <p><strong>Example #1 <span class="function"><strong>eio_cancel()</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">/* Is called when eio_nop() finished */<br /> </span><span style="color: #007700">function </span><span style="color: #0000BB">my_nop_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"my_nop "</span><span style="color: #007700">, </span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> }<br /><br /></span><span style="color: #FF8000">// This eio_nop() call will be cancelled<br /></span><span style="color: #0000BB">$req </span><span style="color: #007700">= </span><span style="color: #0000BB">eio_nop</span><span style="color: #007700">(</span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_nop_cb"</span><span style="color: #007700">, </span><span style="color: #DD0000">"1"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">eio_cancel</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// This time eio_nop() will be processed<br /></span><span style="color: #0000BB">eio_nop</span><span style="color: #007700">(</span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_nop_cb"</span><span style="color: #007700">, </span><span style="color: #DD0000">"2"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Process requests<br /></span><span style="color: #0000BB">eio_event_loop</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> resource(4) of type (EIO Request Descriptor) my_nop 2 </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-function.eio-cancel-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member">eio_grp_cancel</li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.eio-busy.html">eio_busy</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.eio-chmod.html">eio_chmod</a></div> <div class="up"><a href="ref.eio.html">Eio Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>