construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evperiodic.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EvPeriodic::__construct</refname>
  <refpurpose>Constructs EvPeriodic watcher object</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis>
   <modifier>public</modifier>
   <methodname>EvPeriodic::__construct</methodname>
   <methodparam>
    <type>float</type>
    <parameter>offset</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>interval</parameter>
   </methodparam>
   <methodparam>
    <type>callable</type>
    <parameter>reschedule_cb</parameter>
   </methodparam>
   <methodparam>
    <type>callable</type>
    <parameter>callback</parameter>
   </methodparam>
   <methodparam
   choice="opt">
    <type>mixed</type>
    <parameter>data</parameter>
    <initializer>&null;</initializer>
   </methodparam>
   <methodparam
   choice="opt">
    <type>int</type>
    <parameter>priority</parameter>
    <initializer>0</initializer>
   </methodparam>
  </constructorsynopsis>
  <para>
   Constructs EvPeriodic watcher object and starts it automatically.
   <methodname>EvPeriodic::createStopped</methodname>
   method creates stopped periodic watcher.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>offset</parameter>
    </term>
    <listitem>
     <para>
      See
      <link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>interval</parameter>
    </term>
    <listitem>
     <para>
      See
      <link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>reschedule_cb</parameter>
    </term>
    <listitem>
     <para>
      Reschedule callback. You can pass &null;. See
      <link linkend="ev.periodic-modes">Periodic watcher operation
     modes</link>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>callback</parameter>
    </term>
    <listitem>
     <para>
      See
      <link linkend="ev.watcher-callbacks">Watcher callbacks</link>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>data</parameter>
    </term>
    <listitem>
     <para>
      Custom data associated with the watcher.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>priority</parameter>
    </term>
    <listitem>
     <para>
      <link linkend="ev.constants.watcher-pri">Watcher priority</link>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;

 <example>
   <title>Periodic timer. Use reschedule callback</title>
   <programlisting role="php">
<![CDATA[
<?php
// Tick each 10.5 seconds

function reschedule_cb ($watcher, $now) {
 return $now + (10.5. - fmod($now, 10.5));
}

$w = new EvPeriodic(0., 0., "reschedule_cb", function ($w, $revents) {
 echo time(), PHP_EOL;
});
Ev::run();
?>

]]>
   </programlisting>
  </example>
  <example>
   <title>Periodic timer. Tick every 10.5 seconds starting at now</title>
   <programlisting role="php">
<![CDATA[
<?php
// Tick every 10.5 seconds starting at now
$w = new EvPeriodic(fmod(Ev::now(), 10.5), 10.5, NULL, function ($w, $revents) {
 echo time(), PHP_EOL;
});
Ev::run();
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Hourly watcher</title>
   <programlisting role="php">
<![CDATA[
<?php
$hourly = EvPeriodic(0, 3600, NULL, function () {
 echo "once per hour\n";
});
?>
]]>
   </programlisting>
  </example>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member>
    <link linkend="ev.periodic-modes">Periodic watcher operation modes</link>
   </member>
   <member>
    <classname>EvTimer</classname>
   </member>
   <member>
    <methodname>EvPeriodic::createStopped</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
-->