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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="sam.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;
 <variablelist>
  <varlistentry xml:id="constant.sam-auto">
   <term>
    <constant>SAM_AUTO</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Automatic behaviour
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-boolean">
   <term>
    <constant>SAM_BOOLEAN</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Type specifier used when setting properties on SAM_Message objects.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-bus">
   <term>
    <constant>SAM_BUS</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute used to set the name of the enterprise service bus to
     connect to.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-byte">
   <term>
    <constant>SAM_BYTE</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Type specifier used when setting properties on SAM_Message objects.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-bytes">
   <term>
    <constant>SAM_BYTES</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Message body type descriptor.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-correlid">
   <term>
    <constant>SAM_CORRELID</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Attribute used on receive, send and remove requests to identify specific
     messages.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-deliverymode">
   <term>
    <constant>SAM_DELIVERYMODE</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Message header property.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-double">
   <term>
    <constant>SAM_DOUBLE</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Type specifier used when setting properties on SAM_Message objects.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-endpoints">
   <term>
    <constant>SAM_ENDPOINTS</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute used to define the possible endpoints to connect to.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-float">
   <term>
    <constant>SAM_FLOAT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Type specifier used when setting properties on SAM_Message objects.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-host">
   <term>
    <constant>SAM_HOST</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute used to set the hostname of the required messaging
     server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-int">
   <term>
    <constant>SAM_INT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Type specifier used when setting properties on SAM_Message objects.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-long">
   <term>
    <constant>SAM_LONG</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Type specifier used when setting properties on SAM_Message objects.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-manual">
   <term>
    <constant>SAM_MANUAL</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Manual (script controlled) behaviour
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-messageid">
   <term>
    <constant>SAM_MESSAGEID</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Attribute used on receive and remove requests to identify specific
     messages.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-mqtt">
   <term>
    <constant>SAM_MQTT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect protocol definition for selecting the MQTT (MQ Telemetry Transport) protocol.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-mqtt-cleanstart">
   <term>
    <constant>SAM_MQTT_CLEANSTART</constant>
     (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     Optional connect option to indicate to an MQTT server that all previous connection data
     for this client should be removed and that subscriptions should be deleted when the client
     disconnects explicitly or unexpectedly.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-non-persistent">
   <term>
    <constant>SAM_NON_PERSISTENT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute value used to request messages are not made persistent
     on the messaging server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-password">
   <term>
    <constant>SAM_PASSWORD</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute used to define the password to be used for the user
     account being used to connect to a messaging server that requires
     authorisation for connections.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-persistent">
   <term>
    <constant>SAM_PERSISTENT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute value used to request messages are made persistent
     on the messaging server to protect against loss of messages in the
     event of failure.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-port">
   <term>
    <constant>SAM_PORT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute used to set the port number on which to communicate
     with the messaging server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-priority">
   <term>
    <constant>SAM_PRIORITY</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Option name used on send requests to specify a delivery priority value.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-reply-to">
   <term>
    <constant>SAM_REPLY_TO</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Message property used to specify the queue identity on to which the 
     script expects response or reply messages to be posted.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-rtt">
   <term>
    <constant>SAM_RTT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect protocol definition for selecting the IBM Realtime Transport
     protocol for communication with a business integration messaging server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-string">
   <term>
    <constant>SAM_STRING</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Type specifier used when setting properties on SAM_Message objects.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-targetchain">
   <term>
    <constant>SAM_TARGETCHAIN</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connection attribute used to set the required target chain identifier.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-text">
   <term>
    <constant>SAM_TEXT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Message body type descriptor.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-timetolive">
   <term>
    <constant>SAM_TIMETOLIVE</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Message send option name used to specify the length of time a message
     should be retained in milliseconds.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-transactions">
   <term>
    <constant>SAM_TRANSACTIONS</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connection attribute used to set required transactional behaviour. May
     be set to SAM_AUTO (default) or SAM_MANUAL.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-userid">
   <term>
    <constant>SAM_USERID</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect attribute used to define the account to being used to
     connect to a messaging server that requires authorisation for connections.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-wait">
   <term>
    <constant>SAM_WAIT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Receive property used to specify the wait timeout to be used when
     receiving a message from a queue or subscription.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-wmq">
   <term>
    <constant>SAM_WMQ</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect protocol definition for selecting the IBM WebSphere MQSeries
     protocol for communication with the desired messaging server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-wmq-bindings">
   <term>
    <constant>SAM_WMQ_BINDINGS</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect protocol definition for selecting the IBM WebSphere MQSeries
     protocol for communication with a local messaging server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-wmq-client">
   <term>
    <constant>SAM_WMQ_CLIENT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect protocol definition for selecting the IBM WebSphere MQSeries
     protocol for communication with a remote messaging server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-wmq-target-client">
   <term>
    <constant>SAM_WMQ_TARGET_CLIENT</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Option name used on send requests to specify the target client mode. 
     This can either be default to 'jms' or 'mq'. The default is 'jms' which
     means an RFH2 header is sent with the message whereas the 'mq' setting
     means no RFH2 is included.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.sam-wpm">
   <term>
    <constant>SAM_WPM</constant>
     (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Connect protocol definition for selecting the IBM WebSphere Platform
     Messaging protocol for communication with a WebSphere Application Server
     messaging server.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
</appendix>

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