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

<!-- $Revision$ -->

<refentry xml:id="function.pg-get-notify" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>pg_get_notify</refname>

<refpurpose>Gets SQL NOTIFY message</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>array</type><type>false</type></type><methodname>pg_get_notify</methodname>

<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_ASSOC</constant></initializer></methodparam>

</methodsynopsis>

<para>

<function>pg_get_notify</function> gets notifications generated by a

<literal>NOTIFY</literal> SQL command. To receive notifications,

the <literal>LISTEN</literal> SQL command must be

issued.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>connection</parameter></term>

<listitem>

&pgsql.parameter.connection;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>mode</parameter></term>

<listitem>

&pgsql.parameter.mode;

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

An <type>array</type> containing the <literal>NOTIFY</literal> message name and backend PID.

If supported by the server, the array also contains the server version and the payload.

Otherwise if no <literal>NOTIFY</literal> is waiting, then &false; is returned.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&pgsql.changelog.connection-object;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>PostgreSQL NOTIFY message</title>

<programlisting role="php">

<![CDATA[

<?php

$conn = pg_pconnect("dbname=publisher");

if (!$conn) {

echo "An error occurred.\n";

exit;

}

// Listen 'author_updated' message from other processes

pg_query($conn, 'LISTEN author_updated;');

$notify = pg_get_notify($conn);

if (!$notify) {

echo "No messages\n";

} else {

print_r($notify);

}

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>pg_get_pid</function></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

-->