defaultloop.xml

<?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
-->