php-doc-en/reference/sam/reference.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
 <reference xml:id="ref.sam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>SAM &Functions;</title>

  <partintro>

   <!-- FIXME: Upgrade to the new-oo-markup -->
   <!-- class definition section -->
   <section xml:id="sam.classes">
    &reftitle.classes;

<!-- Connection class  -->
    <section xml:id="class.samconnection">
     <title><classname>SAMConnection</classname></title>
     <para>
      Object representing a connection to a Messaging Server
     </para>

     <section>
      &reftitle.constructor;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="samconnection.construct">new SAMConnection</link> - construct a new connection object to allow connection to a messaging infrastructure.
        </para>
       </listitem>
      </itemizedlist>
     </section>

     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="samconnection.commit">commit</link>
         - a method that commits (successfully completes) an in-flight unit
         of work.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.connect">connect</link>
         - a method that connects a PHP script to a messaging server.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.disconnect">disconnect</link>
         - a method that disconnects a PHP script from a messaging server.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.isconnected">isConnected</link>
         - a method that checks whether a PHP script is connected to a
          messaging server.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.peek">peek</link>
         - a method that receives a message from a queue without removing it
          from the queue.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.peekall">peekAll</link>
         - a method that receives one or messages from a queue without
         removing them from the queue.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.receive">receive</link>
         - a method that receives a message from a queue or subscription.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.remove">remove</link>
         - a method that removes a message from a queue.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.rollback">rollback</link>
         - a method that cancels (rolls back) an in-flight unit of work.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.send">send</link>
         - a method that sends a message to a queue or posts to a topic
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.setdebug">setDebug</link>
         - a method that switches additional debugging output on or off
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.subscribe">subscribe</link>
         - a method that creates a subscription to one or more topics
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.unsubscribe">unsubscribe</link>
         - a method that destroys a subscription to one or more topics
        </para>
       </listitem>
      </itemizedlist>
     </section>

     <section>
      &reftitle.properties;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="samconnection.errno">errno</link> - the
         numeric error code for the last encountered error on this
         connection. This property is set to 0 if the last operation was
         successful.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.error">error</link> - the
         text description for the last encountered error on this connection
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>   <!-- xml:id=class.samconnection -->

<!-- Message class    *************************************************** -->
    <section xml:id="class.sammessage">
     <title><classname>SAMMessage</classname></title>
     <para>
      Object representing a message to be sent or received
     </para>

     <section>
      &reftitle.constructor;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sammessage.construct">new SAMMessage</link> - construct a
         new message.
        </para>
       </listitem>
      </itemizedlist>
     </section>

     <section>
      &reftitle.properties;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sammessage.body">body</link> - the body of
         the message.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sammessage.header">header</link> - the
         header properties of the message.
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>   <!-- xml:id=class.sammessage -->

   </section>    <!-- xml:id=sam.classes -->


  </partintro>

  <!-- This seems to create the table of contents -->
 &reference.sam.entities.SAMConnection;
 &reference.sam.entities.SAMMessage;

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