This extension provides access to the functionality of messaging and queueing systems, such
as the IBM WebSphere MQSeries family of products, from PHP scripts. The interface is designed
to make it extremely simple to do the more commonly required tasks such as deliver simple text
messages to queues while still allowing skilled users to do more complex messaging operations.
For many users the complexities of setting up numerous options can be simply ignored.
The SAM extension interfaces to the IBM Messaging and Queuing middleware products using
a set of libraries and some client side code referred to as XMS. This package is
available as a free download in the guise of IBM support pack IA94. There is a description
of this package and download links in the article Introducing XMS - The IBM Message Service API.
If you intend to use SAM to access the Messaging and Queuing infrastructure within
WebSphere MQ then you will also need to have installed a local MQ queue manager or
installed the WebSphere MQ clients package. The clients package is freely available
as a support pack (MQC6).
If you are only aiming to experiment with sending messages to and from WebSphere Application
Server queues using the WebSphere Platform Messaging protocol (WPM) then you do not need
to install the MQC6 package.
After installing these packages you will need to ensure the XMS binary and, if you are
using it, the MQ client bin directory are included in the PATH environment variable
so that Apache and PHP can find the dependent .DLLs/libraries.
The sam extension is supplied as a PECL module, which
you should be able to download and install in one step as follows:
(Depending on your php environment, you will probably need to be root to do this.)
Make sure that the module is loaded by PHP, by adding following line to
php.ini
:
to your php.ini file.
If you cannot use the PEAR installer, you can download the extension and build
it manually:
pear download sam #downloads sam-<version>.tgz
tar -xzf sam-<version>.tgz
cd sam-<version>
phpize
./configure
make
make install #you may need to be root for this step |
To work with the very latest source, you'll need to extract it from cvs and
build manually as above.
Currently you will need to build the sam extension for Windows as there
are no pre-built binaries. The extension can be built using the standard
Windows extension build procedures.
You will need the PHP source tree for the version of PHP you wish to build
the SAM extension against which you can obtain from php.net. This should be
unpacked into a working directory of your choice.
You will also need the libraries and headers used by PHP extensions available
from http://www.php.net/extra/win32build.zip and this should be unzipped so
that is in your working directory.
You should have something like:
c:\php-build\-
|
|---php-5.0.5--|---build
| |---ext
| |--- ...
|
|---win32build--|---bin
|---include
|---lib |
You will need a compiler such as the free version of Visual Studio C++
Express from the Microsoft web site. Also you need the Microsoft Windows
Platform SDK which again can be downloaded from the Microsoft web site.
Obtain the SAM extension source using pear (pear download sam) or by using
CVS and copy the files to a new "sam" directory under the "ext" directory
in your PHP source tree.
To build the extension open a build environment window by going to the
start menu->all programs->microsoft platform SDK for windows->
open build environment window->windows 200 build environment->
set windows 2000 build environment (retail)
This should open a command prompt with all the environment variables set
up to access the platform SDK etc. You then need to set the environment
variables for Visual Studio by issuing the command "vcvars32.bat" in the
window.
Change directory to your working directory e.g. cd c:\php-build. Then
make sure the win32build tools are accessible by adding them to the PATH
environment variable:
set PATH=..\win32build\bin;%PATH% |
Run the buildconf.bat command. This should rebuild the configure.js file.
Run the cscript command:
cscript /nologo configure.js --with-sam="c:\program files\ibm\xms" |
The additional parameter passed for sam is the installation path to the
XMS libraries and runtime that were installed as described under prerequisites
at the top of this file.
You can specify whatever other cscript parameters you require to include or
exclude items from the php build or select options.
Assuming all has gone well so far you can now finally run a make!
If you build the SAM extension with the Microsoft Visual Studio 2005 compiler and
tools you need to perform an additional step in the build process to ensure the
php_sam.dll is able to link with the C runtime libraries at runtime. This step
includes the dependancy manifest into the DLL. Switch to the directory where the
php_sam.dll has been generated (usually Release_TS or Debug_TS below the php
source directory) and issue the following magic incantation:
mt.exe -manifest php_sam.dll.manifest -outputresource:php_sam.dll;2 |
If you build the SAM extension using the compiler and libaries from Microsoft Visual Studio 2005
you will also need to ensure that the runtime components are installed on the system on
which you intend to use SAM. This can be accomplished by installing Visual Studio 2005 or
by using the freely distributable runtime package.
In order to perform any messaging and queueing functions a connection must be established
with a messaging server by creating a SAMConnection object and calling its "connect"
method, with a set of connection properties, to connect the PHP script to the messaging
server. Until such time as the SAMConnection object is destroyed the connection
will be maintained and available for use. All SAMConnection objects are destroyed when
the PHP script exits.
A set of default properties may be used in connecting to a messaging server but as a
minimum the PHP script must specify a protocol to be used.
Example 1. Creating a connection and connecting to a remote WebSphere MQSeries Messaging Server
<?php
$conn = new SAMConnection();
$conn->connect(SAM_WMQ, array(SAM_HOST => myhost.mycompany.com,
SAM_PORT => 1506,
SAM_BROKER => mybroker));
?>
|
|
Example 2. Creating a connection and connecting to a remote WebSphere Application Server
<?php
$conn = new SAMConnection();
$conn->connect(SAM_WMQ, array(SAM_ENDPOINTS => 'localhost:7278:BootstrapBasicMessaging',
SAM_BUS => 'Bus1',
SAM_TARGETCHAIN => 'InboundBasicMessaging'));
?>
|
|
Messages sent to and received from queues are represented by the SAMMessage object. The
SAMMessage object encapsulates the body of the message (if one exists) and the header
properties associated with the message. A SAMMessage object
is either supplied as a parameter to a messaging operation or returned as a result.
Example 3. Creating a message with a simple text body
<?php
$msg = new SAMMessage('This is a simple text message');
?>
|
|
Messages may have header properties associated with them that provide control over the
transport of the message or further information to the receiving application. By default
message properties are delivered to the underlying messaging system as strings and in
this case they may be set with the following simple syntax:
Example 4. Setting a text format property using the default syntax
<?php
$msg->header->myPropertyName = 'textData';
?>
|
|
If it is desired to pass type information an alternative syntax may be used where the
value and the type hint are passed in an associative array:
Example 5. Setting a property using a type hint
<?php
$msg->header->myPropertyName = array(3.14159, SAM_FLOAT);
?>
|
|
Properties may also be extracted from the header of a message.
Example 6. Retrieving a property from a message header
<?php
$myProperty = $msg->header->myPropertyName;
?>
|
|
All messaging operations are performed through calls to methods on the connection object.
To add a message to a queue the "send" method is used, to obtain a message from a queue the
"receive" method is used. Other methods provide publish and subscribe functionality and
control of transaction boundaries.
Example 7. Adding a message to a queue and receiving a response
<?php
$msg = new SAMMessage('This is a simple text message');
$msg->header->SAM_REPLY_TO = 'queue://receive/test';
$correlid = $conn->send('queue://send/test', $msg);
if (!$correlid) {
// The Send failed!
echo "Send failed ($conn->errno) $conn->error";
} else {
$resp = $conn->receive('queue://receive/test', array(SAM_CORRELID => $correlid));
}
?>
|
|
SAM allows messages to be sent either to queues or, for WebSphere MQ and WPM, to publish/subscribe topics.
A topic desintation is specified to SAM in the usual way, i.e. in the form 'topic://fred', rather than the form
'queue://AQUEUE' used for point to point operation. To use publish/subscribe it is simply necessary to specify the
correct broker name on the SAMConnect "connect" call and the desired topic in the destination argument to the SAMConnect "send"
and "receive" calls. The PHP interface is otherwise identical to the point to point model.
By default, SAM creates non-durable subscriptions when using publish/subscribe. This means that if a client application is
inactive when messages are published to a topic, then it will not receive them when it subsequently restarted. SAM does also
allow durable subscriptions to be made to topics when using WPM or WebSphere MQ publish/subscribe. The purpose of these
subscriptions is to allow data to be received by a client application even if that client was not active at the time
the data was published.
Durable subscriptions are specified by using the SAMConnect "subscribe" call. This method takes the destination topic as an
input parameter and returns a subscription identifier that may be used on subsequent "receive" calls. When the subscription
is no longer required the SAMConnection "unsubscribe" method should be used to delete the subscription.
Example 8. Creating a durable subscription to a topic
<?php
$subName = $conn->subscribe('topic://A');
if (!$subName) {
echo "Subscribe failed";
} else {
# Subscribe was OK
...
}
?>
|
|
Example 9. Subscribing to a topic using a WebSphere Platform Messaging (WPM) server
<?php
$conn = new SAMConnection();
// Note: For pub/sub on WPM, when connecting the name of a messaging engine
// to hold the durable subscription (SAM_WPM_DUR_SUB_HOME) must be specified.
$conn->connect(SAM_WMQ, array(SAM_ENDPOINTS => 'localhost:7278:BootstrapBasicMessaging',
SAM_BUS => 'Bus1',
SAM_TARGETCHAIN => 'InboundBasicMessaging'
SAM_WPM_DUR_SUB_HOME => 'MyMachineNode01.server1-Bus1'));
$subName = $conn->subscribe('topic://A');
if (!$subName) {
echo "Subscribe failed";
} else {
# Subscribe was OK
...
}
?>
|
|
Example 10. Receiving published data using a durable subscription
<?php
$msg = $conn->receive($subName);
if ($msg) {
echo "Received a message OK";
} else {
echo "The receive failed";
}
?>
|
|
Example 11. Deleting a durable subscription to a topic
<?php
if (!$conn->unsubscribe($subName)) {
echo "Unsubscribe failed";
}
?>
|
|
All SAMConnection methods that provide access to messaging operations return FALSE
if an error occurred in processing the request. In addition the SAMConnection object
has two properties, "errno" and "error", that provide respectively the error number and
text description of the last error to occur on the connection.
Example 12. Handling an error from a method that returns no result
<?php
if (!$conn->commit()) {
// The commit failed!
echo "Commit failed ($conn->errno) $conn->error";
}
?>
|
|
Example 13. Handling an error from a method that returns a result
<?php
$correlid = $conn->send('queue://send/test', $msg);
if (!$correlid) {
// The Send failed!
echo "Send failed ($conn->errno) $conn->error";
} else {
...
}
?>
|
|
3.21.163.198
User Stats:
Today: 0
Yesterday: 0
This Month: 0
This Year: 0
Total Users: 117
New Members:
3.21.xxx.xxx
Server Time: