reference/mysqli/mysqli/poll.xml
c5ccd084c8f830801a939bf1829ddddcaf019730
...
...
@@ -10,29 +10,33 @@
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<para>&style.oop;</para>
13
-
<methodsynopsis role="oop">
14
-
<modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>mysqli::poll</methodname>
15
-
<methodparam><type>array</type><parameter role="reference">read</parameter></methodparam>
16
-
<methodparam><type>array</type><parameter role="reference">error</parameter></methodparam>
13
+
<methodsynopsis role="mysqli">
14
+
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>mysqli::poll</methodname>
15
+
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter role="reference">read</parameter></methodparam>
16
+
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter role="reference">error</parameter></methodparam>
17
17
<methodparam><type>array</type><parameter role="reference">reject</parameter></methodparam>
18
-
<methodparam><type>int</type><parameter>sec</parameter></methodparam>
19
-
<methodparam choice="opt"><type>int</type><parameter>usec</parameter><initializer>0</initializer></methodparam>
18
+
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
19
+
<methodparam choice="opt"><type>int</type><parameter>microseconds</parameter><initializer>0</initializer></methodparam>
20
20
</methodsynopsis>
21
21
<para>&style.procedural;</para>
22
22
<methodsynopsis>
23
-
<type>int</type><methodname>mysqli_poll</methodname>
24
-
<methodparam><type>array</type><parameter role="reference">read</parameter></methodparam>
25
-
<methodparam><type>array</type><parameter role="reference">error</parameter></methodparam>
23
+
<type class="union"><type>int</type><type>false</type></type><methodname>mysqli_poll</methodname>
24
+
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter role="reference">read</parameter></methodparam>
25
+
<methodparam><type class="union"><type>array</type><type>null</type></type><parameter role="reference">error</parameter></methodparam>
26
26
<methodparam><type>array</type><parameter role="reference">reject</parameter></methodparam>
27
-
<methodparam><type>int</type><parameter>sec</parameter></methodparam>
28
-
<methodparam choice="opt"><type>int</type><parameter>usec</parameter><initializer>0</initializer></methodparam>
27
+
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
28
+
<methodparam choice="opt"><type>int</type><parameter>microseconds</parameter><initializer>0</initializer></methodparam>
29
29
</methodsynopsis>
30
30
<para>
31
31
Poll connections.
32
-
&mysqli.available.mysqlnd;
33
32
The method can be used as
34
33
<link linkend="language.oop5.static">static</link>.
35
34
</para>
35
+
<note>
36
+
<para>
37
+
&mysqli.available.mysqlnd;
38
+
</para>
39
+
</note>
36
40
</refsect1>
37
41

38
42
<refsect1 role="parameters">
...
...
@@ -51,7 +55,7 @@
51
55
<term><parameter>error</parameter></term>
52
56
<listitem>
53
57
<para>
54
-
List of connections on which an error occured, for example, query
58
+
List of connections on which an error occurred, for example, query
55
59
failure or lost connection.
56
60
</para>
57
61
</listitem>
...
...
@@ -66,7 +70,7 @@
66
70
</listitem>
67
71
</varlistentry>
68
72
<varlistentry>
69
-
<term><parameter>sec</parameter></term>
73
+
<term><parameter>seconds</parameter></term>
70
74
<listitem>
71
75
<para>
72
76
Maximum number of seconds to wait, must be non-negative.
...
...
@@ -74,7 +78,7 @@
74
78
</listitem>
75
79
</varlistentry>
76
80
<varlistentry>
77
-
<term><parameter>usec</parameter></term>
81
+
<term><parameter>microseconds</parameter></term>
78
82
<listitem>
79
83
<para>
80
84
Maximum number of microseconds to wait, must be non-negative.
...
...
@@ -92,6 +96,39 @@
92
96
</para>
93
97
</refsect1>
94
98

99
+
<refsect1 role="errors">
100
+
&reftitle.errors;
101
+
<para>
102
+
A <classname>ValueError</classname> is thrown when neither
103
+
the <parameter>read</parameter> nor <parameter>error</parameter> arguments are passed.
104
+
</para>
105
+
</refsect1>
106
+

107
+
<refsect1 role="changelog">
108
+
&reftitle.changelog;
109
+
<para>
110
+
<informaltable>
111
+
<tgroup cols="2">
112
+
<thead>
113
+
<row>
114
+
<entry>&Version;</entry>
115
+
<entry>&Description;</entry>
116
+
</row>
117
+
</thead>
118
+
<tbody>
119
+
<row>
120
+
<entry>8.3.0</entry>
121
+
<entry>
122
+
Now throws a <classname>ValueError</classname> exception when neither
123
+
the <parameter>read</parameter> nor <parameter>error</parameter> arguments are passed.
124
+
</entry>
125
+
</row>
126
+
</tbody>
127
+
</tgroup>
128
+
</informaltable>
129
+
</para>
130
+
</refsect1>
131
+

95
132
<refsect1 role="examples">
96
133
&reftitle.examples;
97
134
<para>
...
...
@@ -148,7 +185,6 @@ Array
148
185
</refsect1>
149
186

150
187
</refentry>
151
-

152
188
<!-- Keep this comment at the end of the file
153
189
Local variables:
154
190
mode: sgml
155
191