Files
Leonardo Lara Rodrigues 70d4f99f47 sync with en rev
2026-01-09 09:54:04 -03:00

133 lines
4.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: c142be811735a5542c8a2e4c4ed2f81e8cc3acc6 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xml:id="pdo-pgsql.getnotify" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Pdo\Pgsql::getNotify</refname>
<refpurpose>Recebe notificação assíncrona</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>
Retorna um conjunto de resultados que representa uma notificação assíncrona pendente.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>fetchMode</parameter></term>
<listitem>
<para>
O formato como o conjunto de resultados deve ser retornado,
uma das seguintes constantes:
<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>
O tempo de espera por uma resposta, em milissegundos.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Se uma ou mais notificações estiverem pendentes, retorna uma única
linha, com os campos <literal>message</literal> e <literal>pid</literal>,
caso contrário retorna &false;.
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
Uma exceção <exceptionname>ValueError</exceptionname> será lançada se
<parameter>fetchMode</parameter> não for uma das constantes
<constant>PDO::FETCH_<replaceable>*</replaceable></constant>
válidas.
</simpara>
<simpara>
Uma exceção <exceptionname>ValueError</exceptionname> será lançada se
<parameter>timeoutMilliseconds</parameter> for menor que <literal>0</literal>.
</simpara>
<simpara>
Um <constant>E_WARNING</constant> é gerado quando
<parameter>timeoutMilliseconds</parameter> é maior que o valor
que pode estar contido em um inteiro com sinal de 32 bits; nesse caso, será o
valor máximo de um inteiro com sinal de 32 bits.
</simpara>
</refsect1>
<!-- TODO?
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="pdo-pgsql.getnotify.example.basic">
<title><methodname>Pdo\Pgsql::getNotify</methodname> example</title>
<simpara>
Description.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
echo "Code example";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Code example
]]>
</screen>
</example>
</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
-->