php-doc-en/reference/ev/evtimer/set.xml
Ruslan Osmanov 8d666e8198 Applied XML formatting
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328910 c90b9560-bf6c-de11-be94-00142212c4b1
2012-12-27 17:33:55 +00:00

84 lines
2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="evtimer.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EvTimer::set</refname>
<refpurpose>Configures the watcher</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type>
<methodname>EvTimer::set</methodname>
<methodparam>
<type>double</type>
<parameter>after</parameter>
</methodparam>
<methodparam>
<type>double</type>
<parameter>repeat</parameter>
</methodparam>
</methodsynopsis>
<para>
Configures the watcher
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>after</parameter>
</term>
<listitem>
<para>
Configures the timer to trigger after
<parameter>after</parameter>
seconds.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>repeat</parameter>
</term>
<listitem>
<para>
If repeat is
<constant>0.0</constant>
, then it will automatically be stopped once the timeout is reached. If
it is positive, then the timer will automatically be configured to
trigger again every repeat seconds later, until stopped manually.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</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
-->