eio-cancel.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b38591439b2afe309740774f5fa41cafe32c72b9 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->

<refentry xml:id="function.eio-cancel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>eio_cancel</refname>
  <refpurpose>リクエストを取り消す</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>eio_cancel</methodname>
   <methodparam><type>resource</type><parameter>req</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>eio_cancel</function> は、
   <parameter>req</parameter> で指定したリクエストを取り消します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>req</parameter></term>
    <listitem>
     <para>
     リクエストリソース。
     </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>
     <parameter>callback</parameter> に渡す任意の引数。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
  &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>eio_cancel</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
 /* eio_nop() が終わったら呼ばれます */
 function my_nop_cb($data, $result) {
  echo "my_nop ", $data, "\n";
 }

// この eio_nop() の呼び出しは取り消されます
$req = eio_nop(EIO_PRI_DEFAULT, "my_nop_cb", "1");
var_dump($req);
eio_cancel($req);

// この eio_nop() は処理されます
eio_nop(EIO_PRI_DEFAULT, "my_nop_cb", "2");

// リクエストを処理します
eio_event_loop();
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
resource(4) of type (EIO Request Descriptor)
my_nop 2
]]>
   </screen>
  </example>
 </refsect1>


 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>eio_grp_cancel</function></member>
  </simplelist>
 </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
-->