<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="pdo-pgsql.getnotify" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>Pdo\Pgsql::getNotify</refname>

<refpurpose>Get asynchronous notification</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>

Returns a result set representing a pending asynchronous notification.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>fetchMode</parameter></term>

<listitem>

<para>

The format the result set should be returned as,

one of the following constants:

<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>

The length of time to wait for a response, in milliseconds.

</simpara>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

If one or more notifications is pending, returns a single row,

with fields <literal>message</literal> and <literal>pid</literal>,

otherwise returns &false;.

</simpara>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<simpara>

A <exceptionname>ValueError</exceptionname> is thrown if

<parameter>fetchMode</parameter> is not one of the valid

<constant>PDO::FETCH_<replaceable>*</replaceable></constant>

constants.

</simpara>

<simpara>

A <exceptionname>ValueError</exceptionname> is thrown if

<parameter>timeoutMilliseconds</parameter> is less than <literal>0</literal>.

</simpara>

<simpara>

A <constant>E_WARNING</constant> is raised when

<parameter>timeoutMilliseconds</parameter> is greater than the value

that can be contained in a signed 32-bit integer, in which case it will be

the maximum value of a signed 32-bit integer.

</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

-->