<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Predefined Constants</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sam.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sam.examples.html">Examples</a></div>
<div class="up"><a href="book.sam.html">SAM</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="sam.constants" class="appendix">
<h1>Predefined Constants</h1>
<p class="simpara">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</p>
<dl>
<dt id="constant.sam-auto">
<span class="term">
<strong><code>SAM_AUTO</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Automatic behaviour
</span>
</dd>
</dt>
<dt id="constant.sam-boolean">
<span class="term">
<strong><code>SAM_BOOLEAN</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Type specifier used when setting properties on SAM_Message objects.
</span>
</dd>
</dt>
<dt id="constant.sam-bus">
<span class="term">
<strong><code>SAM_BUS</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect attribute used to set the name of the enterprise service bus to
connect to.
</span>
</dd>
</dt>
<dt id="constant.sam-byte">
<span class="term">
<strong><code>SAM_BYTE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Type specifier used when setting properties on SAM_Message objects.
</span>
</dd>
</dt>
<dt id="constant.sam-bytes">
<span class="term">
<strong><code>SAM_BYTES</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Message body type descriptor.
</span>
</dd>
</dt>
<dt id="constant.sam-correlid">
<span class="term">
<strong><code>SAM_CORRELID</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Attribute used on receive, send and remove requests to identify specific
messages.
</span>
</dd>
</dt>
<dt id="constant.sam-deliverymode">
<span class="term">
<strong><code>SAM_DELIVERYMODE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Message header property.
</span>
</dd>
</dt>
<dt id="constant.sam-double">
<span class="term">
<strong><code>SAM_DOUBLE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Type specifier used when setting properties on SAM_Message objects.
</span>
</dd>
</dt>
<dt id="constant.sam-endpoints">
<span class="term">
<strong><code>SAM_ENDPOINTS</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect attribute used to define the possible endpoints to connect to.
</span>
</dd>
</dt>
<dt id="constant.sam-float">
<span class="term">
<strong><code>SAM_FLOAT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Type specifier used when setting properties on SAM_Message objects.
</span>
</dd>
</dt>
<dt id="constant.sam-host">
<span class="term">
<strong><code>SAM_HOST</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect attribute used to set the hostname of the required messaging
server.
</span>
</dd>
</dt>
<dt id="constant.sam-int">
<span class="term">
<strong><code>SAM_INT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Type specifier used when setting properties on SAM_Message objects.
</span>
</dd>
</dt>
<dt id="constant.sam-long">
<span class="term">
<strong><code>SAM_LONG</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Type specifier used when setting properties on SAM_Message objects.
</span>
</dd>
</dt>
<dt id="constant.sam-manual">
<span class="term">
<strong><code>SAM_MANUAL</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Manual (script controlled) behaviour
</span>
</dd>
</dt>
<dt id="constant.sam-messageid">
<span class="term">
<strong><code>SAM_MESSAGEID</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Attribute used on receive and remove requests to identify specific
messages.
</span>
</dd>
</dt>
<dt id="constant.sam-mqtt">
<span class="term">
<strong><code>SAM_MQTT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect protocol definition for selecting the MQTT (MQ Telemetry Transport) protocol.
</span>
</dd>
</dt>
<dt id="constant.sam-mqtt-cleanstart">
<span class="term">
<strong><code>SAM_MQTT_CLEANSTART</code></strong>
(<span class="type"><a href="language.types.boolean.html" class="type bool">bool</a></span>)
</span>
<dd>
<span class="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.
</span>
</dd>
</dt>
<dt id="constant.sam-non-persistent">
<span class="term">
<strong><code>SAM_NON_PERSISTENT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect attribute value used to request messages are not made persistent
on the messaging server.
</span>
</dd>
</dt>
<dt id="constant.sam-password">
<span class="term">
<strong><code>SAM_PASSWORD</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="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.
</span>
</dd>
</dt>
<dt id="constant.sam-persistent">
<span class="term">
<strong><code>SAM_PERSISTENT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="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.
</span>
</dd>
</dt>
<dt id="constant.sam-port">
<span class="term">
<strong><code>SAM_PORT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect attribute used to set the port number on which to communicate
with the messaging server.
</span>
</dd>
</dt>
<dt id="constant.sam-priority">
<span class="term">
<strong><code>SAM_PRIORITY</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Option name used on send requests to specify a delivery priority value.
</span>
</dd>
</dt>
<dt id="constant.sam-reply-to">
<span class="term">
<strong><code>SAM_REPLY_TO</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Message property used to specify the queue identity on to which the
script expects response or reply messages to be posted.
</span>
</dd>
</dt>
<dt id="constant.sam-rtt">
<span class="term">
<strong><code>SAM_RTT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect protocol definition for selecting the IBM Realtime Transport
protocol for communication with a business integration messaging server.
</span>
</dd>
</dt>
<dt id="constant.sam-string">
<span class="term">
<strong><code>SAM_STRING</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Type specifier used when setting properties on SAM_Message objects.
</span>
</dd>
</dt>
<dt id="constant.sam-targetchain">
<span class="term">
<strong><code>SAM_TARGETCHAIN</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connection attribute used to set the required target chain identifier.
</span>
</dd>
</dt>
<dt id="constant.sam-text">
<span class="term">
<strong><code>SAM_TEXT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Message body type descriptor.
</span>
</dd>
</dt>
<dt id="constant.sam-timetolive">
<span class="term">
<strong><code>SAM_TIMETOLIVE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Message send option name used to specify the length of time a message
should be retained in milliseconds.
</span>
</dd>
</dt>
<dt id="constant.sam-transactions">
<span class="term">
<strong><code>SAM_TRANSACTIONS</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connection attribute used to set required transactional behaviour. May
be set to SAM_AUTO (default) or SAM_MANUAL.
</span>
</dd>
</dt>
<dt id="constant.sam-userid">
<span class="term">
<strong><code>SAM_USERID</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect attribute used to define the account to being used to
connect to a messaging server that requires authorisation for connections.
</span>
</dd>
</dt>
<dt id="constant.sam-wait">
<span class="term">
<strong><code>SAM_WAIT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Receive property used to specify the wait timeout to be used when
receiving a message from a queue or subscription.
</span>
</dd>
</dt>
<dt id="constant.sam-wmq">
<span class="term">
<strong><code>SAM_WMQ</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect protocol definition for selecting the IBM WebSphere MQSeries
protocol for communication with the desired messaging server.
</span>
</dd>
</dt>
<dt id="constant.sam-wmq-bindings">
<span class="term">
<strong><code>SAM_WMQ_BINDINGS</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect protocol definition for selecting the IBM WebSphere MQSeries
protocol for communication with a local messaging server.
</span>
</dd>
</dt>
<dt id="constant.sam-wmq-client">
<span class="term">
<strong><code>SAM_WMQ_CLIENT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect protocol definition for selecting the IBM WebSphere MQSeries
protocol for communication with a remote messaging server.
</span>
</dd>
</dt>
<dt id="constant.sam-wmq-target-client">
<span class="term">
<strong><code>SAM_WMQ_TARGET_CLIENT</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="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.
</span>
</dd>
</dt>
<dt id="constant.sam-wpm">
<span class="term">
<strong><code>SAM_WPM</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</span>
<dd>
<span class="simpara">
Connect protocol definition for selecting the IBM WebSphere Platform
Messaging protocol for communication with a WebSphere Application Server
messaging server.
</span>
</dd>
</dt>
</dl>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sam.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sam.examples.html">Examples</a></div>
<div class="up"><a href="book.sam.html">SAM</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
