<!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>Execute custom request like any other eio_* call.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.eio-close.html">eio_close</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.eio-dup2.html">eio_dup2</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-custom" class="refentry">
<div class="refnamediv">
<h1 class="refname">eio_custom</h1>
<p class="verinfo">(PECL eio >= 0.0.1dev)</p><p class="refpurpose"><span class="refname">eio_custom</span> — <span class="dc-title">Execute custom request like any other <em class="emphasis">eio_*</em> call.</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.eio-custom-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>eio_custom</strong></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$execute</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$pri</code></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"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$data</code><span class="initializer"> = NULL</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>eio_custom()</strong></span> executes custom function specified by
<em><code class="parameter">execute</code></em> processing it just like any other <em class="emphasis">eio_*</em> call.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.eio-custom-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">execute</code></em></span>
<dd>
<p class="para">
Specifies the request function that should match the following prototype:
<div class="example-contents"><div class="cdata"><pre>
mixed execute(mixed data);
</pre></div></div>
<em><code class="parameter">callback</code></em> is event completion callback that should match the following
prototype:
<div class="example-contents"><div class="cdata"><pre>
void callback(mixed data, mixed result);
</pre></div></div>
<em><code class="parameter">data</code></em> is the data passed to
<em><code class="parameter">execute</code></em> via <em><code class="parameter">data</code></em> argument
without modifications
<em><code class="parameter">result</code></em> value returned by <em><code class="parameter">execute</code></em>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">pri</code></em></span>
<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, <em><code class="parameter">pri</code></em> internally is set to
<strong><code>EIO_PRI_DEFAULT</code></strong>.
</p>
</dd>
</dt>
<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-custom-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>eio_custom()</strong></span> returns request resource on success or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.eio-custom-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3588">
<p><strong>Example #1 <span class="function"><strong>eio_custom()</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">/* Callback for the custom callback */<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_custom_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 /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">[</span><span style="color: #DD0000">'data_modified'</span><span style="color: #007700">]);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">[</span><span style="color: #DD0000">'result'</span><span style="color: #007700">]);<br />}<br /><br /></span><span style="color: #FF8000">/* The custom request */<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_custom</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'result' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1001</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'data_modified' </span><span style="color: #007700">=> </span><span style="color: #DD0000">"my custom data"</span><span style="color: #007700">,<br /> );<br /><br /> return </span><span style="color: #0000BB">$result</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #DD0000">"my_custom_data"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$req </span><span style="color: #007700">= </span><span style="color: #0000BB">eio_custom</span><span style="color: #007700">(</span><span style="color: #DD0000">"my_custom"</span><span style="color: #007700">, </span><span style="color: #0000BB">EIO_PRI_DEFAULT</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_custom_callback"</span><span style="color: #007700">, </span><span style="color: #0000BB">$data</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_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)
string(14) "my_custom_data"
string(14) "my_custom_data"
int(2)
string(14) "my custom data"
int(1001)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.eio-close.html">eio_close</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.eio-dup2.html">eio_dup2</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>
