mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
dd07341fae
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343888 c90b9560-bf6c-de11-be94-00142212c4b1
154 lines
4 KiB
XML
154 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.eio-custom" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>eio_custom</refname>
|
|
<refpurpose>Execute custom request like any other <emphasis>eio_*</emphasis> call</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>eio_custom</methodname>
|
|
<methodparam><type>callable</type><parameter>execute</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
|
|
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
|
|
<methodparam
|
|
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>eio_custom</function> executes custom function specified by
|
|
<parameter>execute</parameter> processing it just like any other <emphasis>eio_*</emphasis> call.
|
|
</para>
|
|
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>execute</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the request function that should match the following prototype:
|
|
|
|
<programlisting><![CDATA[
|
|
mixed execute(mixed data);
|
|
]]></programlisting>
|
|
<parameter>callback</parameter> is event completion callback that should match the following
|
|
prototype:
|
|
<programlisting><![CDATA[
|
|
void callback(mixed data, mixed result);
|
|
]]></programlisting>
|
|
|
|
<parameter>data</parameter> is the data passed to
|
|
<parameter>execute</parameter> via <parameter>data</parameter> argument
|
|
without modifications
|
|
<parameter>result</parameter> value returned by <parameter>execute</parameter>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pri</parameter></term>
|
|
<listitem>
|
|
&eio.request.pri.values;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
&eio.callback.proto;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Arbitrary variable passed to <parameter>callback</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>eio_custom</function> returns request resource on success or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>eio_custom</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* Callback for the custom callback */
|
|
function my_custom_callback($data, $result) {
|
|
var_dump($data);
|
|
var_dump(count($result));
|
|
var_dump($result['data_modified']);
|
|
var_dump($result['result']);
|
|
}
|
|
|
|
/* The custom request */
|
|
function my_custom($data) {
|
|
var_dump($data);
|
|
|
|
$result = array(
|
|
'result' => 1001,
|
|
'data_modified' => "my custom data",
|
|
);
|
|
|
|
return $result;
|
|
}
|
|
|
|
$data = "my_custom_data";
|
|
$req = eio_custom("my_custom", EIO_PRI_DEFAULT, "my_custom_callback", $data);
|
|
var_dump($req);
|
|
eio_event_loop();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
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)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|