-
Notifications
You must be signed in to change notification settings - Fork 70
/
settimercallback.xml
92 lines (85 loc) · 3.22 KB
/
settimercallback.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: be295015d068095fc92880baef4e47038646adbd Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="zmqdevice.settimercallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZMQDevice::setTimerCallback</refname>
<refpurpose>Установить callback-функцию по таймеру</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>ZMQDevice</type><methodname>ZMQDevice::setTimerCallback</methodname>
<methodparam><type>callable</type><parameter>cb_func</parameter></methodparam>
<methodparam><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>user_data</parameter></methodparam>
</methodsynopsis>
<para>
Устанавливает callback-функцию по таймеру. Периодически
запускает callback-функцию. От callback-функции простоя отличается
тем, что запускается в любом случае, а не только при простое устройства.
Сигнатура функции - (mixed $user_data).
Добавлено в версии 1.1.0.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cb_func</parameter></term>
<listitem>
<para>
Callback-функция для запуска по таймеру.
Возврат &false; или значения, которое приводится к &false; приведёт
к остановке устройства.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
Время ожидания в миллисекундах. Callback-функция будет
вызываться через заданные промежутки времени.
Гарантирует, что между запусками функции будет происходить
не менее заданного количества миллисекунд.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter></term>
<listitem>
<para>
Дополнительные данные, которые будут передаваться в callback-функцию.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает текущий объект.
</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
-->