1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evloop.defaultloop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EvLoop::defaultLoop</refname>
<refpurpose>Returns or creates the default event loop</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>EvLoop</type>
<methodname>EvLoop::defaultLoop</methodname>
<methodparam
choice="opt">
<type>int</type>
<parameter>flags</parameter>
<initializer>Ev::FLAG_AUTO</initializer>
</methodparam>
<methodparam
choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>NULL</initializer>
</methodparam>
<methodparam
choice="opt">
<type>float</type>
<parameter>io_interval</parameter>
<initializer>0.</initializer>
</methodparam>
<methodparam
choice="opt">
<type>float</type>
<parameter>timeout_interval</parameter>
<initializer>0.</initializer>
</methodparam>
</methodsynopsis>
<para>
If the default event loop is not created,
<methodname>EvLoop::defaultLoop</methodname>
creates it with the specified parameters. Otherwise, it just returns the
object representing previously created instance ignoring all the
parameters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>flags</parameter>
</term>
<listitem>
<para>
One of the
<link linkend="ev.constants.loop-flags">event loop flags</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>data</parameter>
</term>
<listitem>
<para>
Custom data to associate with the loop.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>io_collect_interval</parameter>
</term>
<listitem>
<para>
See
<link linkend="evloop.props.io-interval">io_interval</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>timeout_collect_interval</parameter>
</term>
<listitem>
<para>
See
<link linkend="evloop.props.timeout-interval">timeout_interval</link>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns EvLoop object on success.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EvLoop::__construct</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
-->
|