From 1f77a8e4b0319045dc6344ba66a608440420be84 Mon Sep 17 00:00:00 2001 From: Dave Renshaw Date: Tue, 6 Feb 2007 15:13:09 +0000 Subject: [PATCH] Updates for MQTT support git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229149 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../sam/functions/SAM-Connection-connect.xml | 331 ++++++++---------- .../sam/functions/SAM-Connection-setdebug.xml | 92 +++++ 2 files changed, 242 insertions(+), 181 deletions(-) create mode 100644 reference/sam/functions/SAM-Connection-setdebug.xml diff --git a/reference/sam/functions/SAM-Connection-connect.xml b/reference/sam/functions/SAM-Connection-connect.xml index 25b76a6fe2..728912471f 100644 --- a/reference/sam/functions/SAM-Connection-connect.xml +++ b/reference/sam/functions/SAM-Connection-connect.xml @@ -1,5 +1,5 @@ - + SAMConnection->connect() @@ -42,63 +42,57 @@ seperated by a colon (:) character. Acceptable values are described by the following table: - - - - Protocol string - Constant - Usage - - - - - wmq - SAM_WMQ - - 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. - - - - wmq:client - SAM_WMQ_CLIENT - - 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. - - - - wmq:bindings - SAM_WMQ_BINDINGS - - 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. - - - - wpm - SAM_WPM - - 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. - - - - rtt - SAM_RTT - - Use the IBM Realtime transport protocol to connect to the - messaging infrastructure. - - - - + + + + Protocol string + Constant + Usage + + + + + mqtt + SAM_MQTT + Use the MQTT (MQ Telemetry Transport) protocol connecting as a client to a server. + + + wmq + SAM_WMQ + 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. + + + wmq:client + SAM_WMQ_CLIENT + 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. + + + + wmq:bindings + SAM_WMQ_BINDINGS + 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. + + + wpm + SAM_WPM + 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. + + + rtt + SAM_RTT + Use the IBM Realtime transport protocol to connect to the + messaging infrastructure. + + + @@ -111,129 +105,104 @@ the connection required. The following table lists the available property names and accepted values: - - - - Property name - default - Usage - - - - - SAM_BROKER - none - - - The name of the broker or queue manager running on the messaging - server. - - - This property must be set if using one of the variants of the - WebSphere MQSeries protocol (SAM_WMQ, SAM_WMQ_CLIENT, - SAM_WMQ_BINDINGS). - - - - - SAM_HOST - localhost - - The hostname of the machine on which the messaging server is - running. - - - - SAM_PORT - 1414 for SAM_WMQ - or 1506 for SAM_WPM - - - The port number on which to attempt communication with the - messaging server. - - - - SAM_CLIENT_ID - none - - - A string used to uniquely identify the client when accessing - subscriptions. - - - Warning: Not yet implemented! - - - - - SAM_EXPIRE_AFTER - 0 - - - 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. - - - Warning: Not yet implemented! - - - - - SAM_MESSAGE_PERSISTENCE - none - - - 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. - - - Warning: Not yet implemented! - - - - - SAM_PASSWORD - none - - The password to be used when the Messaging Server to which the - connection is being made requires authentication. - - - - SAM_TRANSACTIONS - SAM_AUTO - - 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. - - - - SAM_USERID - none - - The user id to be used when the Messaging Server to which the - connection is being made requires authentication. - - - - SAM_WPM_DUR_SUB_HOME - none - - The name of the messaging engine where durable subscriptions - are managed. (WPM ONLY). - - - - + + + + Property name + default + Usage + + + + + SAM_BROKER + none + + The name of the broker or queue manager running on the messaging server. + + This property must be set if using one of the variants of the WebSphere + MQSeries protocol (SAM_WMQ, SAM_WMQ_CLIENT, SAM_WMQ_BINDINGS). + + + + + SAM_HOST + localhost + + The hostname of the machine on which the messaging server is running. + + + + SAM_PORT + 1414 for SAM_WMQ + or 1506 for SAM_WPM + + + The port number on which to attempt communication with the messaging server. + + + + SAM_EXPIRE_AFTER + 0 + + 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. + + Warning: Not yet implemented! + + + + + SAM_MESSAGE_PERSISTENCE + none + + 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. + + Warning: Not yet implemented! + + + + + SAM_MQTT_CLEANSTART + none + + 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. + + + + SAM_PASSWORD + none + + The password to be used when the Messaging Server to which the connection is being made requires authentication. + + + + SAM_TRANSACTIONS + SAM_AUTO + + 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. + + + + SAM_USERID + none + + The user id to be used when the Messaging Server to which the connection is being made requires authentication. + + + + SAM_WPM_DUR_SUB_HOME + none + + The name of the messaging engine where durable subscriptions are managed. (WPM ONLY). + + + + diff --git a/reference/sam/functions/SAM-Connection-setdebug.xml b/reference/sam/functions/SAM-Connection-setdebug.xml new file mode 100644 index 0000000000..5ef9035a27 --- /dev/null +++ b/reference/sam/functions/SAM-Connection-setdebug.xml @@ -0,0 +1,92 @@ + + + + + SAMConnection::setDebug() + + Turn on or off additional debugging output. + + + + + &reftitle.description; + + 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. + + + SAMConnection + + voidsend + boolswitch + + + + + + &reftitle.parameters; + + + + switch + + + 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. + + + + + + + + + + &reftitle.examples; + + + Turn on debugging output + +setdebug(TRUE); +?> +]]> + + + + + + Turn off debugging output + +setdebug(FALSE); +?> +]]> + + + + + + +