Initial release of documentation

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@250916 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philippe Tjon - A - Hen 2008-01-19 20:29:01 +00:00
parent 08684a8561
commit 045b5b22c3
22 changed files with 2533 additions and 0 deletions

View file

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- Purpose: basic.php -->
<!-- Membership: pecl -->
<book xml:id="book.mqseries" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>mqseries</title>
<!-- {{{ preface -->
<preface xml:id="intro.mqseries">
&reftitle.intro;
<simpara>
This extension aims to provide an interface for communicating with IBMs
WebSphere MQ series Queue managers.
</simpara>
<simpara>
The interface mimics the C-API client interface of WebSphere MQ Series as
close as posible. Using the same naming conventions and posibilities of the
C-API. In order to understand the workings of this extention some level of
understanding the C-API is required.
</simpara>
<simpara>
For MQ-options, MQ-structures, MQ-results etc. please read the WebSphere MQ
Application Programming Guide and WebSphere MQ Application Programming
Reference.
</simpara>
</preface>
<!-- }}} -->
&reference.mqseries.setup;
&reference.mqseries.constants;
&reference.mqseries.reference;
</book>
<!-- 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
-->

View file

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="mqseries.configure" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
&pecl.moved;
</para>
<para>
&pecl.info; <link xlink:href="&url.pecl.package;mqseries">&url.pecl.package;mqseries</link>.
</para>
<note>
<simpara>
The official name of this extension is <emphasis>mqseries</emphasis>.
</simpara>
</note>
<para>
There are two ways to connecto to a queue manager. These depend on the way the extention is compiled and linked.
<itemizedlist>
<listitem>
<para>First one and also the default one is using the mqic libraries. Compiling and linking the
extention against these IBM WebSphere MQSeries libraries allows the extention to connect to the
Queue manager using the client interface. Remote conections are posible this way.</para>
</listitem>
<listitem>
<para>The other way is to compile and link against the mqm libraries. Using these libraries it is
possible to make use of the transaction management of a queue manager.</para>
</listitem>
</itemizedlist>
</para>
<para>Currently selecting the libraries to use is done by changing the config.m4 file.</para>
</section>
<!-- 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
-->

View file

@ -0,0 +1,67 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<appendix xml:id="mqseries.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
<para>
For each WebSphere MQ Constant there is a mqseries conterpart.
</para>
<para>For definitions and usage see the WebSphere MQ Application Programming Guide and WebSphere MQ
Application Programming Reference red books.
</para>
<para>The name of the mqseries counterpart is made by appending the WebSphere MQ constant with MQSERIES_,
for example the CompletionCode constants are:
</para>
<para>
<table>
<title>mqseries constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>PHP Constant</entry>
<entry>MQ Constant</entry>
</row>
</thead>
<tbody>
<row>
<entry>MQSERIES_MQCC_OK</entry>
<entry>MQCC_OK</entry>
</row>
<row>
<entry>MQSERIES_MQCC_WARNING</entry>
<entry>MQCC_WARNING</entry>
</row>
<row>
<entry>MQSERIES_MQCC_FAILED</entry>
<entry>MQCC_FAILED</entry>
</row>
<row>
<entry>MQSERIES_MQCC_UNKNOWN</entry>
<entry>MQCC_UNKNOWN</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</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:"../../../../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
-->

View file

@ -0,0 +1,14 @@
&reference.mqseries.functions.mqseries-back;
&reference.mqseries.functions.mqseries-begin;
&reference.mqseries.functions.mqseries-close;
&reference.mqseries.functions.mqseries-cmit;
&reference.mqseries.functions.mqseries-conn;
&reference.mqseries.functions.mqseries-connx;
&reference.mqseries.functions.mqseries-disc;
&reference.mqseries.functions.mqseries-get;
&reference.mqseries.functions.mqseries-inq;
&reference.mqseries.functions.mqseries-open;
&reference.mqseries.functions.mqseries-put1;
&reference.mqseries.functions.mqseries-put;
&reference.mqseries.functions.mqseries-set;
&reference.mqseries.functions.mqseries-strerror;

View file

@ -0,0 +1,146 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-back" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_back</refname>
<refpurpose>MQSeries MQBACK</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_back</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_back</function>
(MQBACK) call indicates to the queue manager that all the message gets and
puts that have occurred since the last syncpoint are to be backed out.
Messages put as part of a unit of work are deleted; messages retrieved as
part of a unit of work are reinstated on the queue.
</para>
<para>
Using
<function>mqseries_back</function>
only works in conjunction with
<function>mqseries_begin</function>
and only function when connecting directly to a Queueu manager. Not via the
mqclient interface.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_back</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
mqseries_back($conn, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<function>mqseries_back</function>
will not function when using MQSeries Client to connect to a Queueu Manager.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
<member><function>mqseries_begin</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,156 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-begin" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_begin</refname>
<refpurpose>MQseries MQBEGIN</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_begin</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>array</type>
<parameter>beginOptions</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_begin</function>
(MQBEGIN) call begins a unit of work that is coordinated by the queue
manager, and that may involve external resource managers.
</para>
<para>
Using
<function>mqseries_begin</function>
starts the unit of work. Either
<function>mqseries_back</function>
or
<function>mqseries_cmit</function>
ends the unit of work.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_begin</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
$mqbo = array();
mqseries_begin( $conn,
$mqbo,
$comp_code,
$reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
/* reason code 2121 is a warning for more information see MQSeries reference manual.*/
if ($reason !== 2121) {
printf("CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
}
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<function>mqseries_begin</function>
will not function when using MQSeries Client to connect to a Queueu Manager.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
<member><function>mqseries_back</function></member>
<member><function>mqseries_cmit</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,139 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_close</refname>
<refpurpose>MQSeries MQCLOSE</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_close</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resource</type>
<parameter>hobj</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_close</function>
(MQCLOSE) call relinquishes access to an object, and is the inverse of the
<function>mqseries_open</function>
(MQOPEN) call.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_close</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("close CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_open</function></member>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,139 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-cmit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_cmit</refname>
<refpurpose>MQSeries MQCMIT</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_cmit</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_cmit</function>
(MQCMIT) call indicates to the queue manager that the application has reached
a syncpoint, and that all of the message gets and puts that have occurred
since the last syncpoint are to be made permanent. Messages put as part of a
unit of work are made available to other applications; messages retrieved as
part of a unit of work are deleted.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_cmit</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
mqseries_cmit($conn, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("cmit CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<function>mqseries_back</function>
will not function when using MQSeries Client to connect to a Queueu Manager.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_begin</function></member>
<member><function>mqseries_back</function></member>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,138 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-conn" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_conn</refname>
<refpurpose>MQSeries MQCONN</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_conn</methodname>
<methodparam>
<type>string</type>
<parameter>qManagerName</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_conn</function>
(MQCONN) call connects an application program to a queue manager. It provides
a queue manager connection handle, which is used by the application on
subsequent message queuing calls.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>qManagerName</parameter>
</term>
<listitem>
<para>Name of queue manager.</para>
<para>Name of the queueu manager the application wishes to connect.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_conn</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
mqseries_conn('WMQ1', $conn, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("conn CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
exit;
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_disc</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,161 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-connx" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_connx</refname>
<refpurpose>MQSeries MQCONNX</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_connx</methodname>
<methodparam>
<type>string</type>
<parameter>qManagerName</parameter>
</methodparam>
<methodparam>
<type>array</type>
<parameter>connOptions</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_connx</function>
(MQCONNX) call connects an application program to a queue manager. It
provides a queue manager connection handle, which is used by the application
on subsequent MQ calls.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>qManagerName</parameter>
</term>
<listitem>
<para>Name of queue manager.</para>
<para>Name of the queueu manager the application wishes to connect.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>connOps</parameter>
</term>
<listitem>
<para>Options that control the action of function</para>
<para>See also the MQCNO structure.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_connx</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
$mqcno = array(
'Version' => MQSERIES_MQCNO_VERSION_2,
'Options' => MQSERIES_MQCNO_STANDARD_BINDING,
'MQCD' => array('ChannelName' => 'MQNX9420.CLIENT',
'ConnectionName' => 'localhost',
'TransportType' => MQSERIES_MQXPT_TCP)
);
mqseries_connx('MQNX9420', $mqcno, $conn, $comp_code,$reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("Connx CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
exit;
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_disc</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,128 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-disc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_disc</refname>
<refpurpose>MQSeries MQDISC</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_disc</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_disc</function>
(MQDISC) call breaks the connection between the queue manager and the
application program, and is the inverse of the
<function>mqseries_conn</function>
(MQCONN) or
<function>mqseries_connx</function>
(MQCONNX) call.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_disc</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
mqseries_disc($conn, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("disc CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,218 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-get" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_get</refname>
<refpurpose>MQSeries MQGET</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_get</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resource</type>
<parameter>hobj</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_get</function>
(MQGET) call retrieves a message from a local queue that has been opened
using the
<function>mqseries_open</function>
(MQOPEN) call
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>md</parameter>
</term>
<listitem>
<para>Message descriptor (MQMD).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>gmo</parameter>
</term>
<listitem>
<para>Get message options (MQGMO).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bufferLength</parameter>
</term>
<listitem>
<para>Expected length of the result buffer</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>msg</parameter>
</term>
<listitem>
<para>
Buffer holding the message that was retreived from the object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>data_length</parameter>
</term>
<listitem>
<para>Actual buffer length</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_getx</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
// open connection to the queue manager
mqseries_conn('WMQ1', $conn, $comp_code, $reason);
// $conn now hold the reference to the connection to the queue manager.
// open the connectio to the testq queueu
mqseries_open(
$conn,
array('ObjectName' => 'TESTQ'),
MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT,
$obj,
$comp_code,
$reason);
// $obj now holds the reference to the object (TESTQ)
// setup empty message descriptor.
mdg = array();
// setup get message options
$gmo = array('Options' => MQSERIES_MQGMO_FAIL_IF_QUIESCING | MQSERIES_MQGMO_WAIT, 'WaitInterval' => 3000);
// get the message from the queueu
mqseries_get($conn, $obj, $mdg, $gmo, 255, $msg, $data_length, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("GET CompCode:%d Reason:%d Text:%s<br>", $comp_code, $reason, mqseries_strerror($reason));
}
// open connection to the queue manager
mqseries_conn('WMQ1', $conn, $comp_code, $reason);
// $conn now hold the reference to the connection to the queue manager.
// open the connectio to the testq queueu
mqseries_open(
$conn,
array('ObjectName' => 'TESTQ'),
MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT,
$obj,
$comp_code,
$reason);
// $obj now holds the reference to the object (TESTQ)
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
<member><function>mqseries_open</function></member>
<member><function>mqseries_put</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,216 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-inq" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_inq</refname>
<refpurpose>MQSeries MQINQ</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_inq</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resource</type>
<parameter>hobj</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>selectorCount</parameter>
</methodparam>
<methodparam>
<type>array</type>
<parameter>selectors</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>intAttrCount</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>intAttr</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>charAttrLength</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>charAttr</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_inq</function>
(MQINQ) call returns an array of integers and a set of character strings
containing the attributes of an object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>selectorCount</parameter>
</term>
<listitem>
<para>Count of selectors.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>selectors</parameter>
</term>
<listitem>
<para>Array of attribute selectors.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>intAttrLength</parameter>
</term>
<listitem>
<para>Count of integer attributes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>intAttr</parameter>
</term>
<listitem>
<para>Array of integer attributes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>charAttrLength</parameter>
</term>
<listitem>
<para>Length of character attributes buffer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>charAttr</parameter>
</term>
<listitem>
<para>Character attributes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_inq</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
$int_attr = array();
$char_attr = "";
mqseries_inq($conn, $obj, 1, array(MQSERIES_MQCA_Q_MGR_NAME), 0, $int_attr, 48, $char_attr, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("INQ CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
} else {
echo "INQ QManager name result ".$char_attr."<br>\n";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
<member><function>mqseries_open</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,167 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-open" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_open</refname>
<refpurpose>MQSeries MQOPEN</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_open</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>array</type>
<parameter>objDesc</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>option</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>hobj</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_open</function>
(MQOPEN) call establishes access to an object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>objDesc</parameter>
</term>
<listitem>
<para>Object descriptor. (MQOD)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>options</parameter>
</term>
<listitem>
<para>Options that control the action of the function.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_open</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
mqods = array('ObjectName' => 'TESTQ');
mqseries_open(
$conn,
$mqods,
MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT,
$obj,
$comp_code,
$reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("open CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
exit;
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_close</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,195 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-put" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_put</refname>
<refpurpose>MQSeries MQPUT</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_put</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_put</function>
(MQPUT) call puts a message on a queue or distribution list. The queue or
distribution list must already be open.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>md</parameter>
</term>
<listitem>
<para>Message descriptor (MQMD).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>pmo</parameter>
</term>
<listitem>
<para>Put message options (MQPMO).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>message</parameter>
</term>
<listitem>
<para>The actual message to put onto the queue.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_put</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
// open connection to the queue manager
mqseries_conn('WMQ1', $conn, $comp_code, $reason);
// $conn now hold the reference to the connection to the queue manager.
// open the connectio to the testq queueu
mqseries_open(
$conn,
array('ObjectName' => 'TESTQ'),
MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT,
$obj,
$comp_code,
$reason);
// $obj now holds the reference to the object (TESTQ)
// setup the message descriptor array. Check MQSeries reference manuals.
$md = array(
'Version' => MQSERIES_MQMD_VERSION_1,
'Expiry' => MQSERIES_MQEI_UNLIMITED,
'Report' => MQSERIES_MQRO_NONE,
'MsgType' => MQSERIES_MQMT_DATAGRAM,
'Format' => MQSERIES_MQFMT_STRING,
'Priority' => 1,
'Persistence' => MQSERIES_MQPER_PERSISTENT);
// setup the put message options.
$pmo = array('Options' => MQSERIES_MQPMO_NEW_MSG_ID|MQSERIES_MQPMO_SYNCPOINT);
// put the message 'Ping' on the queueu.
mqseries_put($conn, $obj, $md, $pmo, 'Ping', $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("put CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
}
// close the object reference $obj
mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason);
// disconnect from the queue manager.
mqseries_disc($conn, $comp_code, $reason);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
<member><function>mqseries_open</function></member>
<member><function>mqseries_get</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,167 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-put1" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_put1</refname>
<refpurpose>MQSeries MQPUT1</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_put1</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>objDesc</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>msgDesc</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>pmo</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>buffer</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The
<function>mqseries_put1</function>
(MQPUT1) call puts one message on a queue. The queue need not be open.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>objDesc</parameter>
</term>
<listitem>
<para>Object descriptor. (MQOD)</para>
<para>
This is a structure which identifies the queue to which the message is
added.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>msgDesc</parameter>
</term>
<listitem>
<para>Message descriptor (MQMD).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>pmo</parameter>
</term>
<listitem>
<para>Put message options (MQPMO).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_put1</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
TODO:
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
<member><function>mqseries_open</function></member>
<member><function>mqseries_get</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,120 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-set"
xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_set</refname>
<refpurpose>MQSeries MQSET</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_set</methodname>
<methodparam>
<type>resource</type>
<parameter>hconn</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resourceref</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
The <function>mqseries_set</function>
(MQSET) call is used to change the attributes of an object represented by a
handle. The object must be a queue.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_set</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
TODO:
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_inq</function></member>
</simplelist>
</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
-->

View file

@ -0,0 +1,94 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-strerror" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_strerror</refname>
<refpurpose>Returns the error message corresponding to a result code (MQRC).</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>mqseries_strerror</methodname>
<methodparam>
<type>int</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
<function>mqseries_strerror</function>
returns the message that correspond to the reason result code.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>string representation of the reason code message.</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_strerror</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("open CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
exit;
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Connx CompCode:2 Reason:2059 Text:Queue manager not available for connection.
]]>
</screen>
</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
-->

View file

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="mqseries.ini" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>No extra configuration parameters exsists.</para>
</section>
<!-- 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
-->

View file

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<reference xml:id="ref.mqseries">
<title>mqseries &Functions;</title>
&reference.mqseries.entities.functions;
</reference>
<!-- 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
-->

View file

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="mqseries.resources" xmlns="http://docbook.org/ns/docbook">
&reftitle.resources;
<para>
This extension defines a connection and object_handle resources.
</para>
<para>
The <function>mqseries_conn</function> and <function>mqseries_connx</function> define the
connectionn handles.
</para>
<para>
The <function>mqseries_open</function> defines the object handle.
</para>
</section>
<!-- 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
-->

View file

@ -0,0 +1,67 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<chapter xml:id="mqseries.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="mqseries.requirements">
&reftitle.required;
<simpara>
A working IBM WebSphere MQ installation. If building the extention the SDK
for IBM WebSphere MQ is also required.
</simpara>
<note>
<simpara>
Be aware that when running against a IBM WebSphere MQ Client installation
some methods are not available. This is not a problem of the extention but
just the way the WebSphere MQ Client Interface works.
</simpara>
</note>
<section xml:id="mqseries.requirements.nix">
<title>Installation requirements on non windows platforms</title>
<para>Build the extention and put it in the PHP extention directory.</para>
</section>
<section xml:id="mqseries.requirements.windows">
<title>Installation requirements on Windows</title>
<para>No additional requirements.</para>
</section>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.mqseries.configure;
<!-- }}} -->
<!-- {{{ Configuration -->
&reference.mqseries.ini;
<!-- }}} -->
<!-- {{{ Resources -->
&reference.mqseries.resources;
<!-- }}} -->
</chapter>
<!-- 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
-->