dsr Fri Dec 8 17:20:48 2006 UTC
Modified files:
/phpdoc/en/reference/sam/functions SAM-Connection-commit.xml
SAM-Connection-connect.xml
SAM-Connection-constructor.xml
SAM-Connection-disconnect.xml
SAM-Connection-errno.xml
SAM-Connection-error.xml
SAM-Connection-isConnected.xml
SAM-Connection-peek.xml
SAM-Connection-peekall.xml
SAM-Connection-receive.xml
SAM-Connection-remove.xml
SAM-Connection-rollback.xml
SAM-Connection-send.xml
SAM-Connection-subscribe.xml
SAM-Connection-unsubscribe.xml
SAM-Message-body.xml
SAM-Message-constructor.xml
SAM-Message-header.xml
Log:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml Fri Dec 8
17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-commit'>
<refnamediv>
<refname>SAMConnection::commit()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml Fri Dec
8 17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-connect'>
<refnamediv>
<refname>SAMConnection::connect()</refname>
@@ -195,6 +195,13 @@
</para>
</entry>
</row>
+ <row>
+ <entry>SAM_WPM_DUR_SUB_HOME</entry>
+ <entry>none</entry>
+ <entry>
+ The name of the messaging engine where durable subscriptions
are managed. (WPM ONLY).
+ </entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml:1.2
Wed Nov 22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml Fri Dec
8 17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-constructor'>
<refnamediv>
<refname>SAMConnection::SAMConnection()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml Fri Dec
8 17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-disconnect'>
<refnamediv>
<refname>SAMConnection::disconnect()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml Fri Dec 8
17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.SAM-Connection-errno">
<refnamediv>
<refname>SAMConnection->errno</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-error.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-error.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-error.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-error.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-error.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-error.xml Fri Dec 8
17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.SAM-Connection-error">
<refnamediv>
<refname>SAMConnection->error</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml:1.2
Wed Nov 22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml Fri Dec
8 17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-isConnected'>
<refnamediv>
<refname>SAMConnection::isConnected()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml Fri Dec 8
17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-peek'>
<refnamediv>
<refname>SAMConnection::peek()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml:1.1
phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml:1.1 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml Fri Dec
8 17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id='function.SAM-Connection-peekAll'>
<refnamediv>
<refname>SAMConnection::peekAll()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml Fri Dec
8 17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-receive'>
<refnamediv>
<refname>SAMConnection::receive()</refname>
@@ -28,7 +28,7 @@
<term><parameter>target</parameter></term>
<listitem>
<para>
- The identity of the queue from which to receive the message.
+ The identity of the queue, topic or subscription from which to receive
the message.
</para>
</listitem>
</varlistentry>
@@ -115,6 +115,29 @@
</programlisting>
</example>
</para>
+ <para>
+ <example>
+ <title>Receiving a message from a subscription</title>
+ <para>
+ In this example we show how to receive a message from a subscription id.
+ </para>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$msg = $conn->receive($subscriptionName);
+
+if (!$msg) {
+ // The receive failed!
+ echo "Receive failed ($conn->errno) $conn->error";
+}
+?>
+]]>
+ </programlisting>
+ <para>
+ Please note that $subscriptionName is a subscription id returned from an
earlier subscribe call.
+ </para>
+ </example>
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml Fri Dec 8
17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-remove'>
<refnamediv>
<refname>SAMConnection::remove()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml Fri Dec
8 17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-rollback'>
<refnamediv>
<refname>SAMConnection::rollback()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-send.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-send.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-send.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-send.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-send.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-send.xml Fri Dec 8
17:20:48 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-send'>
<refnamediv>
<refname>SAMConnection::send()</refname>
@@ -91,6 +91,14 @@
discarding it. The default value is 0 indicating the message
should be retained indefinitely.
</entry>
</row>
+ <row>
+ <entry>SAM_WMQ_TARGET_CLIENT</entry>
+ <entry>
+ This property is only valid when using WebSphere MQ and
indicates whether or not an RFH2 header should be
+ included with the message. This option may be set to either
'jms' or 'mq'. The default is 'jms' which means
+ that an RFH2 header is included. If the value 'mq' is
specified then no RFH2 is included with the message.
+ </entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml:1.2
phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml:1.3
--- phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml:1.2 Wed Nov
22 17:21:35 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml Fri Dec
8 17:20:48 2006
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id='function.SAM-Connection-subscribe'>
<refnamediv>
<refname>SAMConnection::subscribe()</refname>
<refpurpose>
- Create a subscription to one or more topics.
+ Create a subscription to a specified topic.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
- The "subscribe" method is used to create a new subscription to one or more
topics.
+ The "subscribe" method is used to create a new subscription to a specified
topic.
</para>
<classsynopsis>
<ooclass><classname>SAMConnection</classname></ooclass>
@@ -20,9 +20,6 @@
<methodparam><type>string</type><parameter>targetTopic</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
- <para>
- Warning: This method is not currently implemented.
- </para>
</refsect1>
<refsect1 role="parameters">
@@ -44,7 +41,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- A subscription identifier that can be used in a subsequent receive call as
a selector to obtain any topic data or &false; if an error occurred.
+ A subscription identifier that can be used in a subsequent receive call as
a selector to obtain any topic data or &false; if an error occurred. The
subscription identifier should be used in the receive call in place of the
simple topic name.
</para>
</refsect1>
@@ -52,7 +49,7 @@
&reftitle.examples;
<para>
<example>
- <title>Subscribe to a single topic</title>
+ <title>Subscribe to a topic</title>
<programlisting role="php">
<