dsr             Wed Nov 22 17:21:35 2006 UTC

  Added files:                 
    /phpdoc/en/reference/sam/functions  SAM-Connection-peekall.xml 

  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-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:
  Updates for release 0.2.0 adding install, peek, peekAll and remove details.
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml?r1=1.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml:1.1     Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-commit.xml Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <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.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml:1.1    Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-connect.xml        Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Connection-connect'>
  <refnamediv>
   <refname>SAMConnection::connect()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml?r1=1.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml:1.1        
Mon Nov 13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-constructor.xml    Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <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.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml:1.1 Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-disconnect.xml     Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <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.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml:1.1      Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-errno.xml  Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <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.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-error.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-error.xml:1.1      Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-error.xml  Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
   <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.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml:1.1        
Mon Nov 13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-isConnected.xml    Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <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.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml:1.1       Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-peek.xml   Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Connection-peek'>
  <refnamediv>
   <refname>SAMConnection::peek()</refname>
@@ -18,9 +18,6 @@
       <methodparam 
choice='opt'><type>array</type><parameter>properties</parameter></methodparam>
    </methodsynopsis>
   </classsynopsis>
-   <para>
-   Warning: This method is not currently implemented.
-   </para>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -50,9 +47,13 @@
            </thead>
            <tbody>
              <row>
-               <entry>SAM_SELECT</entry>
-               <entry>String selector used to select messages from the queue. 
Typically this the correlation id string  returned by a "send" request.</entry>
+               <entry>SAM_CORRELID</entry>
+               <entry>This is the target correlation id string of the message. 
This would typically have been returned by a "send" request.</entry>
              </row>
+             <row>
+               <entry>SAM_MESSAGEID</entry>
+               <entry>This is the message id string of the message which is to 
be peeked.</entry>
+             </row>             
            </tbody>
          </tgroup>
        </informaltable>
@@ -96,7 +97,7 @@
 <![CDATA[
 <?php
 
-$msg = $conn->peek('queue://receive/test', array(SAM_SELECT => $token));
+$msg = $conn->peek('queue://receive/test', array(SAM_MESSAGEID => $messageId));
 
 ?>
 ]]>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml?r1=1.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml:1.1    Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-receive.xml        Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Connection-receive'>
  <refnamediv>
   <refname>SAMConnection::receive()</refname>
@@ -47,10 +47,12 @@
            </thead>
            <tbody>
              <row>
-               <entry>SAM_SELECT</entry>
-               <entry>
-                String selector used to select messages from the queue. 
Typically this the correlation id string  returned by a "send" request.
-               </entry>
+               <entry>SAM_CORRELID</entry>
+               <entry>Used to request selection of the message to receive 
based upon the correlation id string of the message.</entry>
+             </row>
+             <row>
+               <entry>SAM_MESSAGEID</entry>
+               <entry>Used to request selection of the message to receive 
based upon the message id string of the message.</entry>
              </row>
              <row>
                <entry>SAM_WAIT</entry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml?r1=1.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml:1.1     Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-remove.xml Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Connection-remove'>
  <refnamediv>
   <refname>SAMConnection::remove()</refname>
@@ -18,9 +18,6 @@
       <methodparam 
choice='opt'><type>array</type><parameter>properties</parameter></methodparam>
    </methodsynopsis>
   </classsynopsis>
-   <para>
-   Warning: This method is not currently implemented.
-   </para>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -50,9 +47,13 @@
            </thead>
            <tbody>
              <row>
-               <entry>SAM_SELECT</entry>
-               <entry>String selector used to select messages from the queue. 
Typically this the correlation id string  returned by a "send" request.</entry>
+               <entry>SAM_CORRELID</entry>
+               <entry>This is the target correlation id string of the message. 
This would typically have been returned by a "send" request.</entry>
              </row>
+             <row>
+               <entry>SAM_MESSAGEID</entry>
+               <entry>This is the message id string of the message which is to 
be removed.</entry>
+             </row>        
            </tbody>
          </tgroup>
        </informaltable>
@@ -74,11 +75,11 @@
   &reftitle.examples;
   <para>
    <example>
-    <title>Removing a message from a queue with options</title>
+    <title>Removing a message from a queue by message id</title>
     <programlisting role="php">
 <![CDATA[
 <?php
-if (!$conn->remove('queue://receive/test', array(SAM_SELECT => $token))) {
+if (!$conn->remove('queue://receive/test', array(SAM_MESSAGEID => 
$messageId))) {
   // The remove failed!
   echo "Remove failed ($conn->errno) $conn->error";
 }
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml?r1=1.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml:1.1   Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-rollback.xml       Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <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.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-send.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-send.xml:1.1       Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-send.xml   Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Connection-send'>
  <refnamediv>
   <refname>SAMConnection::send()</refname>
@@ -78,10 +78,10 @@
               </entry>
              </row>
              <row>
-               <entry>SAM_SELECT</entry>
+               <entry>SAM_CORRELID</entry>
                <entry>
                 A string to be assigned as a correlation id for this message. 
If no value is given the messaging server
-                may assign automatically.
+                may assign a value automatically.
                </entry>
              </row>
              <row>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml?r1=1.1&r2=1.2&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.1 
phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml:1.1  Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-subscribe.xml      Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Connection-subscribe'>
  <refnamediv>
   <refname>SAMConnection::subscribe()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-unsubscribe.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Connection-unsubscribe.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Connection-unsubscribe.xml:1.1 
phpdoc/en/reference/sam/functions/SAM-Connection-unsubscribe.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Connection-unsubscribe.xml:1.1        
Mon Nov 13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Connection-unsubscribe.xml    Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Connection-unsubscribe'>
  <refnamediv>
   <refname>SAMConnection::unsubscribe()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Message-body.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Message-body.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Message-body.xml:1.1 
phpdoc/en/reference/sam/functions/SAM-Message-body.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Message-body.xml:1.1  Mon Nov 13 
16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Message-body.xml      Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Message-body'>
  <refnamediv>
   <refname>SAMMessage::body</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Message-constructor.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Message-constructor.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Message-constructor.xml:1.1 
phpdoc/en/reference/sam/functions/SAM-Message-constructor.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Message-constructor.xml:1.1   Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Message-constructor.xml       Wed Nov 
22 17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Message-constructor'>
  <refnamediv>
   <refname>SAMMessage::SAMMessage()</refname>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Message-header.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/sam/functions/SAM-Message-header.xml
diff -u phpdoc/en/reference/sam/functions/SAM-Message-header.xml:1.1 
phpdoc/en/reference/sam/functions/SAM-Message-header.xml:1.2
--- phpdoc/en/reference/sam/functions/SAM-Message-header.xml:1.1        Mon Nov 
13 16:57:51 2006
+++ phpdoc/en/reference/sam/functions/SAM-Message-header.xml    Wed Nov 22 
17:21:35 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id='function.SAM-Message-header'>
  <refnamediv>
   <refname>SAMMessage::header</refname>
@@ -32,6 +32,13 @@
       </thead>
       <tbody>
         <row>
+          <entry>SAM_MESSAGEID</entry>
+          <entry>
+           When a message is received this field contains the unique 
identifier of the message as allocated
+           by the underlying messaging system. When sending a message this 
field is ignored.
+          </entry>
+        </row>
+        <row>
           <entry>SAM_REPLY_TO</entry>
           <entry>
            A string providing the identity of the queue on to which responses 
to this message should be posted.
@@ -88,7 +95,7 @@
 <?php
    $msg = new SAMMessage();
 
-   $msg->header->myPropertyName = ('textData', SAM_STRING);
+   $msg->header->myPropertyName = array('textData', SAM_STRING);
 ?>
 ]]>
     </programlisting>
@@ -213,7 +220,7 @@
 <![CDATA[
 <?php
 
-   // accessing an application specifc property
+   // accessing an application specific property
    $intProp = $msg->header->'MyIntProp';
 
    // accessing a messaging system specific property

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml
+++ phpdoc/en/reference/sam/functions/SAM-Connection-peekall.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id='function.SAM-Connection-peekAll'>
 <refnamediv>
  <refname>SAMConnection::peekAll()</refname>
  <refpurpose>
   Read one or more messages from a queue without removing it from the queue.
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>SAMConnection</classname></ooclass>
   <methodsynopsis>
    <type>array</type><methodname>peekAll</methodname>
      
<methodparam><type>string</type><parameter>target</parameter></methodparam>
      <methodparam 
choice='opt'><type>array</type><parameter>properties</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>target</parameter></term>
     <listitem>
      <para>
       The identity of the queue from which messages should be peeked.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>properties</parameter></term>
     <listitem>
      <para>
       An optional associative array of properties describing other parameters 
to control the peek operation.
       <informaltable>
         <tgroup cols="2">
           <thead>
             <row>
               <entry>Property name</entry>
               <entry>Possible values</entry>
             </row>
           </thead>
           <tbody>
             <row>
               <entry>SAM_CORRELID</entry>
               <entry>This is the target correlation id string of messages to 
be peeked. This would typically have been returned by a "send" request.</entry>
             </row>
             <row>
               <entry>SAM_MESSAGEID</entry>
               <entry>This is the message id string of a message which is to be 
peeked.</entry>
             </row>             
           </tbody>
         </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   This method returns an array of SAMMessage objects or &false; if an error 
occurs.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Retrieve all messages in a queue without removing them</title>
    <programlisting role="php">
<![CDATA[
<?php
   $msgArray = $conn->peekAll('queue://receive/test');
   if ($msgArray) {

      foreach ( $msgArray as $key => $msg) {
            echo "Message $key: body = $msg->body\n";
         }
      }
   else
      echo "PeekAll failed ($conn->errno) $conn->error";
   }
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Retrieve all messages from a queue with a matching correlation 
id</title>
    <programlisting role="php">
<![CDATA[
<?php

   $msgArray = $conn->peekAll('queue://receive/test', array(SAM_CORRELID => 
$correlId ));
   if ($msgArray) {

      foreach ( $msgArray as $key => $msg) {
            echo "Message $key: body = $msg->body\n";
         }
      }
   else
      echo "PeekAll failed ($conn->errno) $conn->error";
   }

?>
]]>
    </programlisting>
   </example>
  </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:"../../../../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
-->

Reply via email to