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

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

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

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>EvSignal::__construct</methodname>
   <methodparam><type>int</type><parameter>signum</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 EvPeriodic watcher object and starts it automatically.  For a
  stopped periodic watcher consider using
  <methodname>EvSignal::createStopped</methodname> method.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>signum</parameter></term>
    <listitem>
     <para>
     Signal number. See constants exported by <emphasis>pcntl</emphasis>
     extension. See also <literal>signal(7)</literal> man page.
     </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 EvSignal object on success.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
 <example>
  <title>Handle SIGTERM signal</title>
  <programlisting role="php">
<![CDATA[
<?php
$w = new EvSignal(SIGTERM, function ($watcher) {
 echo "SIGTERM received\n";
 $watcher->stop();
});

Ev::run();
?>
]]>
  </programlisting>
 </example>
 </refsect1>


 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>EvSignal::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
-->