File: zookeeper_dispatch.xml

package info (click to toggle)
php-doc 20250827~git.abe740d%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 71,968 kB
  • sloc: xml: 985,760; php: 25,504; javascript: 671; sh: 177; makefile: 37
file content (135 lines) | stat: -rw-r--r-- 3,450 bytes parent folder | download | duplicates (2)
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.zookeeper-dispatch" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>zookeeper_dispatch</refname>
  <refpurpose>Calls callbacks for pending operations</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>zookeeper_dispatch</methodname>
   <void/>
  </methodsynopsis>

  <para>
   The <function>zookeeper_dispatch</function> function calls the callbacks passed by operations like <methodname>Zookeeper::get</methodname> or <methodname>Zookeeper::exists</methodname>.
  </para>

  <caution>
   <para>
    Since version 0.4.0, this function must be called manually to achieve asynchronous operations. If you want that to be done automatically, you also can declare ticks at the beginning of your program.
   </para>
  </caution>

  <para>
   After PHP 7.1, you can ignore this function. This extension uses EG(vm_interrupt) to implement async dispatch.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   This method emits PHP warning when callback could not be invoked.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="function.zookeeper-dispatch.example.1">
   <title><methodname>zookeeper_dispatch</methodname> example #1</title>
   <para>
     Dispatch callbacks manually.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$client = new Zookeeper();
$client->connect('localhost:2181');
$client->get('/zookeeper', function() {
    echo "Callback was called".PHP_EOL;
});
while(true) {
    sleep(1);
    zookeeper_dispatch();
}
?>
]]>
   </programlisting>
  </example>

  <example xml:id="function.zookeeper-dispatch.example.2">
   <title><methodname>zookeeper_dispatch</methodname> example #2</title>
   <para>
     Declare ticks.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
declare(ticks=1);

$client = new Zookeeper();
$client->connect('localhost:2181');
$client->get('/zookeeper', function() {
    echo "Callback was called".PHP_EOL;
});
while(true) {
    sleep(1);
}
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>Zookeeper::addAuth</methodname></member>
    <member><methodname>Zookeeper::connect</methodname></member>
    <member><methodname>Zookeeper::__construct</methodname></member>
    <member><methodname>Zookeeper::exists</methodname></member>
    <member><methodname>Zookeeper::get</methodname></member>
    <member><methodname>Zookeeper::getChildren</methodname></member>
    <member><methodname>Zookeeper::setWatcher</methodname></member>
   </simplelist>
  </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
-->