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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="zmqdevice.setidlecallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZMQDevice::setIdleCallback</refname>
<refpurpose>Set the idle callback function</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>ZMQDevice</type><methodname>ZMQDevice::setIdleCallback</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>
Sets the idle callback function. If idle timeout is defined the idle callback function
shall be called if the internal poll loop times out without events. If the callback function
returns false or a value that evaluates to false the device is stopped.
The callback function signature is callback (mixed $user_data).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cb_func</parameter></term>
<listitem>
<para>
Callback function to invoke when the device is idle. Returning false
or a value that evaluates to false from this function will cause the
device to stop.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
How often to invoke the idle callback in milliseconds. The idle callback is invoked
periodically when there is no activity on the device.
The timeout value guarantees that there is at least this amount of milliseconds between
invocations of the callback function.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter></term>
<listitem>
<para>
Additional data to pass to the callback function.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
On success this method returns the current object.
</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
-->
|
