mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
8d666e8198
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328910 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
3.3 KiB
XML
130 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="evloop.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>EvLoop::run</refname>
|
|
<refpurpose>Begin checking for events and calling callbacks for the loop</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier>
|
|
<type>void</type>
|
|
<methodname>EvLoop::run</methodname>
|
|
<methodparam
|
|
choice="opt">
|
|
<type>int</type>
|
|
<parameter>flags</parameter>
|
|
<initializer>0</initializer>
|
|
</methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Begin checking for events and calling callbacks for the current event loop.
|
|
Returns when a callback calls
|
|
<methodname>Ev::stop</methodname>
|
|
method, or the flags are nonzero(in which case the return value is true) or
|
|
when there are no active watchers which reference the loop(
|
|
<methodname>EvWatcher::keepalive</methodname>
|
|
is &true;), in which case the return value will be &false;. The return
|
|
value can generally be interpreted as
|
|
<emphasis>if &true;, there is more work left
|
|
to do</emphasis>
|
|
.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>flags</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Optional parameter
|
|
<parameter>flags</parameter>
|
|
can be one of the following:
|
|
<table>
|
|
<title>
|
|
List for possible values of <parameter>flags</parameter>
|
|
</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>
|
|
<parameter>flags</parameter>
|
|
</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>
|
|
<constant>0</constant>
|
|
</entry>
|
|
<entry>The default behavior described above</entry>
|
|
</row>
|
|
<row>
|
|
<entry>
|
|
<constant>Ev::RUN_ONCE</constant>
|
|
</entry>
|
|
<entry>Block at most one(wait, but don't loop)</entry>
|
|
</row>
|
|
<row>
|
|
<entry>
|
|
<constant>Ev::RUN_NOWAIT</constant>
|
|
</entry>
|
|
<entry>Don't block at all(fetch/handle events, but don't wait)</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
See
|
|
<link linkend="ev.constants.run-flags">the run flag
|
|
constants</link>
|
|
.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member>
|
|
<methodname>EvLoop::stop</methodname>
|
|
</member>
|
|
<member>
|
|
<methodname>Ev::run</methodname>
|
|
</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
|
|
-->
|