<!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>Createsa request group.</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.eio-grp-limit.html">eio_grp_limit</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.eio-init.html">eio_init</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-grp" class="refentry"> <div class="refnamediv"> <h1 class="refname">eio_grp</h1> <p class="verinfo">(PECL eio >= 0.0.1dev)</p><p class="refpurpose"><span class="refname">eio_grp</span> — <span class="dc-title">Createsa request group.</span></p> </div> <div class="refsect1 description" id="refsect1-function.eio-grp-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">resource</span> <span class="methodname"><strong>eio_grp</strong></span> ( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code><span class="initializer"> = NULL</span></span> ] )</div> <p class="para rdfs-comment"> <span class="function"><strong>eio_grp()</strong></span> creates a request group. </p> </div> <div class="refsect1 parameters" id="refsect1-function.eio-grp-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"><em><code class="parameter">callback</code></em></span> <dd> <p class="para"> <em><code class="parameter">callback</code></em> 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> <span class="term"><em><code class="parameter">data</code></em></span> <dd> <p class="para">is custom data passed to the request.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">result</code></em></span> <dd> <p class="para">request-specific result value; basically, the value returned by corresponding system call.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">req</code></em></span> <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> </dt> </dl> </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">data</code></em></span> <dd> <p class="para"> Arbitrary variable passed to <em><code class="parameter">callback</code></em>. </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-function.eio-grp-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> <span class="function"><strong>eio_grp()</strong></span> returns request group resource on success or <strong><code>FALSE</code></strong> on error. </p> </div> <div class="refsect1 examples" id="refsect1-function.eio-grp-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-3593"> <p><strong>Example #1 <span class="function"><strong>eio_grp()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$temp_filename </span><span style="color: #007700">= </span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">) .</span><span style="color: #DD0000">"/eio-file.tmp"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">, </span><span style="color: #DD0000">"w"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"some data"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$my_file_fd </span><span style="color: #007700">= </span><span style="color: #0000BB">NULL</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Is called when the group requests are done */<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_grp_done</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 /> </span><span style="color: #FF8000">// Remove the file, if it still exists<br /> </span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Is called when the temporary file is opened */<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_grp_file_opened_callback</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 /> global </span><span style="color: #0000BB">$my_file_fd</span><span style="color: #007700">, </span><span style="color: #0000BB">$grp</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$my_file_fd </span><span style="color: #007700">= </span><span style="color: #0000BB">$result</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$req </span><span style="color: #007700">= </span><span style="color: #0000BB">eio_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_file_fd</span><span style="color: #007700">, </span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_grp_file_read_callback"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">eio_grp_add</span><span style="color: #007700">(</span><span style="color: #0000BB">$grp</span><span style="color: #007700">, </span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Is called when the file is read */<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_grp_file_read_callback</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 /> global </span><span style="color: #0000BB">$my_file_fd</span><span style="color: #007700">, </span><span style="color: #0000BB">$grp</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// Create request to close the file<br /> </span><span style="color: #0000BB">$req </span><span style="color: #007700">= </span><span style="color: #0000BB">eio_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_file_fd</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// Add request to the group<br /> </span><span style="color: #0000BB">eio_grp_add</span><span style="color: #007700">(</span><span style="color: #0000BB">$grp</span><span style="color: #007700">, </span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">// Create request group<br /></span><span style="color: #0000BB">$grp </span><span style="color: #007700">= </span><span style="color: #0000BB">eio_grp</span><span style="color: #007700">(</span><span style="color: #DD0000">"my_grp_done"</span><span style="color: #007700">, </span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Create request<br /></span><span style="color: #0000BB">$req </span><span style="color: #007700">= </span><span style="color: #0000BB">eio_open</span><span style="color: #007700">(</span><span style="color: #0000BB">$temp_filename</span><span style="color: #007700">, </span><span style="color: #0000BB">EIO_O_RDWR </span><span style="color: #007700">| </span><span style="color: #0000BB">EIO_O_APPEND </span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_grp_file_opened_callback"</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Add request to the group<br /></span><span style="color: #0000BB">eio_grp_add</span><span style="color: #007700">(</span><span style="color: #0000BB">$grp</span><span style="color: #007700">, </span><span style="color: #0000BB">$req</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> string(4) "some" </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-function.eio-grp-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member">eio_grp_cancel</li> <li class="member">eio_grp_add</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-grp-limit.html">eio_grp_limit</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.eio-init.html">eio_init</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>