sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updates for MQTT support

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229149 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Dave Renshaw 2007-02-06 15:13:09 +00:00
parent cf57a3fb52
commit 1f77a8e4b0
2 changed files with 242 additions and 181 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

331
reference/sam/functions/SAM-Connection-connect.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.samconnection-connect'>
<refnamediv>
<refname>SAMConnection->connect()</refname>
@ -42,63 +42,57 @@
seperated by a colon (:) character. Acceptable values are described by
the following table:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Protocol string</entry>
<entry>Constant</entry>
<entry>Usage</entry>
</row>
</thead>
<tbody>
<row>
<entry>wmq</entry>
<entry>SAM_WMQ</entry>
<entry>
Use the IBM MQSeries protocol connecting as a client to a remote
messaging server. This is equivalent to "wmq:client"
(SAM_WMQ_CLIENT). At least a broker name (SAM_BROKER) must be
specified in the options array.
</entry>
</row>
<row>
<entry>wmq:client</entry>
<entry>SAM_WMQ_CLIENT</entry>
<entry>
Use the IBM MQSeries protocol connecting as a client to a remote
messaging server. At least a broker name (SAM_BROKER) must be
specified in the options array.
</entry>
</row>
<row>
<entry>wmq:bindings</entry>
<entry>SAM_WMQ_BINDINGS</entry>
<entry>
Use the IBM MQSeries protocol connecting to a local messaging
server and communicating via shared memory. At least a broker
name (SAM_BROKER) must be specified in the options array.
</entry>
</row>
<row>
<entry>wpm</entry>
<entry>SAM_WPM</entry>
<entry>
Use the IBM WebSphere Platform Messaging protocol to connect to
the messaging infrastructure of a WebSphere Application server or
cluster. A bus name must be specified in the options array
(SAM_BUS) and endpoint and target chain may also be specified.
</entry>
</row>
<row>
<entry>rtt</entry>
<entry>SAM_RTT</entry>
<entry>
Use the IBM Realtime transport protocol to connect to the
messaging infrastructure.
</entry>
</row>
</tbody>
</tgroup>
<tgroup cols="2">
<thead>
<row>
<entry>Protocol string</entry>
<entry>Constant</entry>
<entry>Usage</entry>
</row>
</thead>
<tbody>
<row>
<entry>mqtt</entry>
<entry>SAM_MQTT</entry>
<entry>Use the MQTT (MQ Telemetry Transport) protocol connecting as a client to a server.</entry>
</row>
<row>
<entry>wmq</entry>
<entry>SAM_WMQ</entry>
<entry>Use the IBM MQSeries protocol connecting as a client to a remote messaging
server. This is equivalent to "wmq:client" (SAM_WMQ_CLIENT). At least a broker name
(SAM_BROKER) must be specified in the options array.</entry>
</row>
<row>
<entry>wmq:client</entry>
<entry>SAM_WMQ_CLIENT</entry>
<entry>Use the IBM MQSeries protocol connecting as a client to a remote messaging
server. At least a broker name (SAM_BROKER) must be specified in the options array.
</entry>
</row>
<row>
<entry>wmq:bindings</entry>
<entry>SAM_WMQ_BINDINGS</entry>
<entry>Use the IBM MQSeries protocol connecting to a local messaging server and
communicating via shared memory. At least a broker name (SAM_BROKER) must be
specified in the options array.</entry>
</row>
<row>
<entry>wpm</entry>
<entry>SAM_WPM</entry>
<entry>Use the IBM WebSphere Platform Messaging protocol to connect to the
messaging infrastructure of a WebSphere Application server or cluster. A bus name
must be specified in the options array (SAM_BUS) and endpoint and target chain
may also be specified.</entry>
</row>
<row>
<entry>rtt</entry>
<entry>SAM_RTT</entry>
<entry>Use the IBM Realtime transport protocol to connect to the
messaging infrastructure.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
@ -111,129 +105,104 @@
the connection required. The following table lists the available
property names and accepted values:
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>Property name</entry>
<entry>default</entry>
<entry>Usage</entry>
</row>
</thead>
<tbody>
<row>
<entry>SAM_BROKER</entry>
<entry>none</entry>
<entry>
<para>
The name of the broker or queue manager running on the messaging
server.
</para>
<para>
This property must be set if using one of the variants of the
WebSphere MQSeries protocol (SAM_WMQ, SAM_WMQ_CLIENT,
SAM_WMQ_BINDINGS).
</para>
</entry>
</row>
<row>
<entry>SAM_HOST</entry>
<entry>localhost</entry>
<entry>
The hostname of the machine on which the messaging server is
running.
</entry>
</row>
<row>
<entry>SAM_PORT</entry>
<entry>1414 for SAM_WMQ
or 1506 for SAM_WPM
</entry>
<entry>
The port number on which to attempt communication with the
messaging server.
</entry>
</row>
<row>
<entry>SAM_CLIENT_ID</entry>
<entry>none</entry>
<entry>
<para>
A string used to uniquely identify the client when accessing
subscriptions.
</para>
<para>
Warning: Not yet implemented!
</para>
</entry>
</row>
<row>
<entry>SAM_EXPIRE_AFTER</entry>
<entry>0</entry>
<entry>
<para>
Time in milliseconds after which a message is deemed to have
expired and can be deleted from queues. The default value is 0
indicating the message never expires.
</para>
<para>
Warning: Not yet implemented!
</para>
</entry>
</row>
<row>
<entry>SAM_MESSAGE_PERSISTENCE</entry>
<entry>none</entry>
<entry>
<para>
Selects whether messages are made persistent during delivery.
The value may be SAM_PERSISTENT or SAM_NON_PERSISTENT. The
default is dependant on the connection type and capabilities
of the Messaging Server to which the connection is made.
</para>
<para>
Warning: Not yet implemented!
</para>
</entry>
</row>
<row>
<entry>SAM_PASSWORD</entry>
<entry>none</entry>
<entry>
The password to be used when the Messaging Server to which the
connection is being made requires authentication.
</entry>
</row>
<row>
<entry>SAM_TRANSACTIONS</entry>
<entry>SAM_AUTO</entry>
<entry>
Indicates how transactions are handled on this connection. The
value may be SAM_AUTO (the default) to allow automatic handling
on a per operation basis or SAM_MANUAL to allow the PHP script
to control the transaction boundaries. If SAM_MANUAL is used any
in-flight transactions will be rolled back if the script is
terminated or the connection is closed without a commit being
executed.
</entry>
</row>
<row>
<entry>SAM_USERID</entry>
<entry>none</entry>
<entry>
The user id to be used when the Messaging Server to which the
connection is being made requires authentication.
</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>
<tgroup cols="3">
<thead>
<row>
<entry>Property name</entry>
<entry>default</entry>
<entry>Usage</entry>
</row>
</thead>
<tbody>
<row>
<entry>SAM_BROKER</entry>
<entry>none</entry>
<entry>
The name of the broker or queue manager running on the messaging server.
<para>
This property must be set if using one of the variants of the WebSphere
MQSeries protocol (SAM_WMQ, SAM_WMQ_CLIENT, SAM_WMQ_BINDINGS).
</para>
</entry>
</row>
<row>
<entry>SAM_HOST</entry>
<entry>localhost</entry>
<entry>
The hostname of the machine on which the messaging server is running.
</entry>
</row>
<row>
<entry>SAM_PORT</entry>
<entry>1414 for SAM_WMQ
or 1506 for SAM_WPM
</entry>
<entry>
The port number on which to attempt communication with the messaging server.
</entry>
</row>
<row>
<entry>SAM_EXPIRE_AFTER</entry>
<entry>0</entry>
<entry>
Time in milliseconds after which a message is deemed to have expired and can be
deleted from queues. The default value is 0 indicating the message never expires.
<para>
Warning: Not yet implemented!
</para>
</entry>
</row>
<row>
<entry>SAM_MESSAGE_PERSISTENCE</entry>
<entry>none</entry>
<entry>
Selects whether messages are made persistent during delivery. The value may be
SAM_PERSISTENT or SAM_NON_PERSISTENT. The default is dependant on the connection
type and capabilities of the Messaging Server to which the connection is made.
<para>
Warning: Not yet implemented!
</para>
</entry>
</row>
<row>
<entry>SAM_MQTT_CLEANSTART</entry>
<entry>none</entry>
<entry>
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.
</entry>
</row>
<row>
<entry>SAM_PASSWORD</entry>
<entry>none</entry>
<entry>
The password to be used when the Messaging Server to which the connection is being made requires authentication.
</entry>
</row>
<row>
<entry>SAM_TRANSACTIONS</entry>
<entry>SAM_AUTO</entry>
<entry>
Indicates how transactions are handled on this connection. The value may be SAM_AUTO (the default) to allow automatic handling on a per operation basis or SAM_MANUAL to allow the PHP script to control the transaction boundaries. If SAM_MANUAL is used any in-flight transactions will be rolled back if the script is terminated or the connection is closed without a commit being executed.
</entry>
</row>
<row>
<entry>SAM_USERID</entry>
<entry>none</entry>
<entry>
The user id to be used when the Messaging Server to which the connection is being made requires authentication.
</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>
</para>
</listitem>

92
reference/sam/functions/SAM-Connection-setdebug.xml Normal file
View file

@ -0,0 +1,92 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision -->
<refentry id='function.samconnection-setDebug'>
<refnamediv>
<refname>SAMConnection::setDebug()</refname>
<refpurpose>
Turn on or off additional debugging output.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
The "setdebug" method is used to turn on or off additional debugging output. The SAM framework will provide method/function
entry and exit trace data plus additional information. Protocol specific implementations also provide extra output.
</para>
<classsynopsis>
<ooclass><classname>SAMConnection</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>send</methodname>
<methodparam><type>bool</type><parameter>switch</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>switch</parameter></term>
<listitem>
<para>
If this parameter is set to &true additional debugging output will be provided. If the value is set to &false output
of additional information will be stopped.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Turn on debugging output</title>
<programlisting role="php">
<![CDATA[
<?php
$conn->setdebug(TRUE);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Turn off debugging output</title>
<programlisting role="php">
<![CDATA[
<?php
$conn->setdebug(FALSE);
?>
]]>
</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
-->