-
Notifications
You must be signed in to change notification settings - Fork 79
Expand file tree
/
Copy pathgetnotify.xml
More file actions
108 lines (102 loc) · 4.28 KB
/
getnotify.xml
File metadata and controls
108 lines (102 loc) · 4.28 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c142be811735a5542c8a2e4c4ed2f81e8cc3acc6 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="pdo-pgsql.getnotify" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Pdo\Pgsql::getNotify</refname>
<refpurpose>Получает асинхронное уведомление</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Pdo\\Pgsql">
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>Pdo\Pgsql::getNotify</methodname>
<methodparam choice="opt"><type>int</type><parameter>fetchMode</parameter><initializer><constant>PDO::FETCH_DEFAULT</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeoutMilliseconds</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<simpara>
Возвращает набор результатов, представляющий ожидающее асинхронное уведомление.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>fetchMode</parameter></term>
<listitem>
<para>
Формат, в котором должен быть возвращён набор результатов,
одна из следующих констант:
<simplelist>
<member><constant>PDO::FETCH_DEFAULT</constant></member>
<member><constant>PDO::FETCH_BOTH</constant></member>
<member><constant>PDO::FETCH_ASSOC</constant></member>
<member><constant>PDO::FETCH_NUM</constant></member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeoutMilliseconds</parameter></term>
<listitem>
<simpara>
Длительность ожидания ответа, в миллисекундах.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Если одно или несколько уведомлений находятся на рассмотрении,
возвращает одну строку с полями <literal>message</literal> и <literal>pid</literal>,
в противном случае возвращает значение &false;.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
Если значение параметра <parameter>fetchMode</parameter> не является одной из допустимых констант
<constant>PDO::FETCH_<replaceable>*</replaceable></constant>,
выбрасывается ошибка <exceptionname>ValueError</exceptionname>.
</simpara>
<simpara>
Если значение параметра <parameter>timeoutMilliseconds</parameter> меньше <literal>0</literal>,
выбрасывается ошибка <exceptionname>ValueError</exceptionname>.
</simpara>
<simpara>
Если значение параметра <parameter>timeoutMilliseconds</parameter> больше
значения, которое может содержаться в 32-битном целом числе со знаком,
выбрасывается ошибка уровня <constant>E_WARNING</constant>,
а значением параметра будет максимальное значение 32-битного целого числа со знаком.
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>PDO::query</methodname></member>
<member><methodname>PDOStatement::fetch</methodname></member>
<member><methodname>PDOStatement::fetchAll</methodname></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
-->