php-doc-en/reference/ev/evstat/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="evstat.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EvStat::__construct</refname>
  <refpurpose>Constructs EvStat watcher object</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>EvStat::__construct</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam><type>double</type><parameter>interval</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>
  </methodsynopsis>
  <para>
  Constructs EvStat watcher object and starts the watcher automatically.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>path</parameter></term>
    <listitem>
     <para>
     The path to wait for status changes on.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>interval</parameter></term>
    <listitem>
     <para>
      Hint on how quickly a change is expected to be detected and should
      normally be specified as <constant>0.0</constant> to let
      <emphasis>libev</emphasis> choose a suitable value.
     </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="returnvalues">
  &reftitle.returnvalues;
  <para>
  Returns EvStat watcher object on succes.
  </para>
 </refsect1>

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

 <example>
  <title>Monitor changes of /var/log/messages</title>
  <programlisting role="php">
<![CDATA[
<?php
// Use 10 second update interval.
$w = new EvStat("/var/log/messages", 8, function ($w) {
 echo "/var/log/messages changed\n";

 $attr = $w->attr();

 if ($attr['nlink']) {
  printf("Current size: %ld\n", $attr['size']);
  printf("Current atime: %ld\n", $attr['atime']);
  printf("Current mtime: %ld\n", $attr['mtime']);
 } else {
  fprintf(STDERR, "`messages` file is not there!");
  $w->stop();
 }
});

Ev::run();
?>
]]>
  </programlisting>
 </example>
 </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
-->