Files
Leonardo Lara Rodrigues 17d859faaf sync line numbers with en rev
2026-01-23 09:16:58 -03:00

174 lines
4.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b4fbf4434abeca44c58575ff3967e5640f7877d5 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="evtimer.createstopped">
<refnamediv>
<refname>EvTimer::createStopped</refname>
<refpurpose>Cria objeto observador EvTimer parado</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier>
<modifier>public</modifier>
<modifier>static</modifier>
<type>EvTimer</type>
<methodname>EvTimer::createStopped</methodname>
<methodparam>
<type>float</type>
<parameter>after</parameter>
</methodparam>
<methodparam>
<type>float</type>
<parameter>repeat</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>
<simpara>
Cria objeto observador EvTimer parado. Diferentemente de
<methodname>EvTimer::__construct</methodname>,
esse método não inicia o observador automaticamente.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>after</parameter>
</term>
<listitem>
<simpara>
Configura o temporizador para disparo após
<parameter>after</parameter>
segundos.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>repeat</parameter>
</term>
<listitem>
<simpara>
Se este parâmetro for
<literal>0.0</literal>,
o temporizador será automaticamente parado quando o tempo limite for atingido.
Se for positivo, será o intervalo em segundos no qual o temporizador será
automaticamente configurado para disparar novamente, até ser parado manualmente.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>callback</parameter>
</term>
<listitem>
<simpara>
Consulte
<link linkend="ev.watcher-callbacks">funções de retorno observadoras</link>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>data</parameter>
</term>
<listitem>
<simpara>
Dados personalizados associados com o observador.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>priority</parameter>
</term>
<listitem>
<simpara>
<link linkend="ev.constants.watcher-pri">Prioridade de observadores</link>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna um objeto EvTimer watcher em caso de sucesso.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Monitora alterações em /var/log/messages. Evita perder atualizações por meio de um atraso de um segundo</title>
<programlisting role="php">
<![CDATA[
<?php
$timer = EvTimer::createStopped(0., 1.02, function ($w) {
$w->stop();
$stat = $w->data;
// 1 segundo após a alteração mais recente do arquivo
printf("Tamanho atual: %ld\n", $stat->attr()['size']);
});
$stat = new EvStat("/var/log/messages", 0., function () use ($timer) {
// Reinicia o observador do temporizador
$timer->again();
});
$timer->data = $stat;
Ev::run();
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EvTimer::__construct</methodname>
</member>
<member>
<classname>EvPeriodic</classname>
</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
-->