diff --git a/reference/mqseries/book.xml b/reference/mqseries/book.xml new file mode 100644 index 0000000000..3d22d6788c --- /dev/null +++ b/reference/mqseries/book.xml @@ -0,0 +1,56 @@ + + + + + + + mqseries + + + + &reftitle.intro; + + This extension aims to provide an interface for communicating with IBMs + WebSphere MQ series Queue managers. + + + 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. + + + For MQ-options, MQ-structures, MQ-results etc. please read the WebSphere MQ + Application Programming Guide and WebSphere MQ Application Programming + Reference. + + + + + &reference.mqseries.setup; + &reference.mqseries.constants; + &reference.mqseries.reference; + + + + + diff --git a/reference/mqseries/configure.xml b/reference/mqseries/configure.xml new file mode 100644 index 0000000000..d957ffd13f --- /dev/null +++ b/reference/mqseries/configure.xml @@ -0,0 +1,52 @@ + + +
+ &reftitle.install; + + &pecl.moved; + + + &pecl.info; &url.pecl.package;mqseries. + + + + The official name of this extension is mqseries. + + + + There are two ways to connecto to a queue manager. These depend on the way the extention is compiled and linked. + + + 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. + + + 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. + + + + Currently selecting the libraries to use is done by changing the config.m4 file. +
+ + diff --git a/reference/mqseries/constants.xml b/reference/mqseries/constants.xml new file mode 100644 index 0000000000..033fcff843 --- /dev/null +++ b/reference/mqseries/constants.xml @@ -0,0 +1,67 @@ + + + + &reftitle.constants; + + For each WebSphere MQ Constant there is a mqseries conterpart. + + For definitions and usage see the WebSphere MQ Application Programming Guide and WebSphere MQ + Application Programming Reference red books. + + The name of the mqseries counterpart is made by appending the WebSphere MQ constant with MQSERIES_, + for example the CompletionCode constants are: + + + + mqseries constants + + + + PHP Constant + MQ Constant + + + + + MQSERIES_MQCC_OK + MQCC_OK + + + MQSERIES_MQCC_WARNING + MQCC_WARNING + + + MQSERIES_MQCC_FAILED + MQCC_FAILED + + + MQSERIES_MQCC_UNKNOWN + MQCC_UNKNOWN + + + +
+ + + + + diff --git a/reference/mqseries/entities.functions.xml b/reference/mqseries/entities.functions.xml new file mode 100644 index 0000000000..1beeb01502 --- /dev/null +++ b/reference/mqseries/entities.functions.xml @@ -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; diff --git a/reference/mqseries/functions/mqseries-back.xml b/reference/mqseries/functions/mqseries-back.xml new file mode 100644 index 0000000000..d8c3362410 --- /dev/null +++ b/reference/mqseries/functions/mqseries-back.xml @@ -0,0 +1,146 @@ + + + + + mqseries_back + MQSeries MQBACK + + + + &reftitle.description; + + mqseries_back + + resource + hconn + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_back + (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. + + + Using + mqseries_back + only works in conjunction with + mqseries_begin + and only function when connecting directly to a Queueu manager. Not via the + mqclient interface. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_back</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + } +?> +]]> + + + + + + + &reftitle.notes; + + + mqseries_back + will not function when using MQSeries Client to connect to a Queueu Manager. + + + + + + &reftitle.seealso; + + + mqseries_conn + mqseries_connx + mqseries_begin + + + + + + diff --git a/reference/mqseries/functions/mqseries-begin.xml b/reference/mqseries/functions/mqseries-begin.xml new file mode 100644 index 0000000000..ed9b7ae34e --- /dev/null +++ b/reference/mqseries/functions/mqseries-begin.xml @@ -0,0 +1,156 @@ + + + + + mqseries_begin + MQseries MQBEGIN + + + + &reftitle.description; + + mqseries_begin + + resource + hconn + + + array + beginOptions + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_begin + (MQBEGIN) call begins a unit of work that is coordinated by the queue + manager, and that may involve external resource managers. + + + Using + mqseries_begin + starts the unit of work. Either + mqseries_back + or + mqseries_cmit + ends the unit of work. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_begin</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + } + } +?> +]]> + + + + + + + &reftitle.notes; + + + mqseries_begin + will not function when using MQSeries Client to connect to a Queueu Manager. + + + + + + &reftitle.seealso; + + + mqseries_conn + mqseries_connx + mqseries_back + mqseries_cmit + + + + + + diff --git a/reference/mqseries/functions/mqseries-close.xml b/reference/mqseries/functions/mqseries-close.xml new file mode 100644 index 0000000000..00bf3d65ca --- /dev/null +++ b/reference/mqseries/functions/mqseries-close.xml @@ -0,0 +1,139 @@ + + + + + mqseries_close + MQSeries MQCLOSE + + + + &reftitle.description; + + mqseries_close + + resource + hconn + + + resource + hobj + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_close + (MQCLOSE) call relinquishes access to an object, and is the inverse of the + mqseries_open + (MQOPEN) call. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + hObj + + + Object handle. + This handle represents the object to be used. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_close</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + } +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_open + mqseries_conn + mqseries_connx + + + + + + diff --git a/reference/mqseries/functions/mqseries-cmit.xml b/reference/mqseries/functions/mqseries-cmit.xml new file mode 100644 index 0000000000..313a760e06 --- /dev/null +++ b/reference/mqseries/functions/mqseries-cmit.xml @@ -0,0 +1,139 @@ + + + + + mqseries_cmit + MQSeries MQCMIT + + + + &reftitle.description; + + mqseries_cmit + + resource + hconn + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_cmit + (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. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_cmit</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + } +?> +]]> + + + + + + + &reftitle.notes; + + + mqseries_back + will not function when using MQSeries Client to connect to a Queueu Manager. + + + + + + &reftitle.seealso; + + + mqseries_begin + mqseries_back + mqseries_conn + mqseries_connx + + + + + + diff --git a/reference/mqseries/functions/mqseries-conn.xml b/reference/mqseries/functions/mqseries-conn.xml new file mode 100644 index 0000000000..63d4929e0e --- /dev/null +++ b/reference/mqseries/functions/mqseries-conn.xml @@ -0,0 +1,138 @@ + + + + + mqseries_conn + MQSeries MQCONN + + + + &reftitle.description; + + mqseries_conn + + string + qManagerName + + + resourceref + hconn + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_conn + (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. + + + + + &reftitle.parameters; + + + + + qManagerName + + + Name of queue manager. + Name of the queueu manager the application wishes to connect. + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_conn</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + exit; + } +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_disc + + + + + + diff --git a/reference/mqseries/functions/mqseries-connx.xml b/reference/mqseries/functions/mqseries-connx.xml new file mode 100644 index 0000000000..daca2eb6c9 --- /dev/null +++ b/reference/mqseries/functions/mqseries-connx.xml @@ -0,0 +1,161 @@ + + + + + mqseries_connx + MQSeries MQCONNX + + + + &reftitle.description; + + mqseries_connx + + string + qManagerName + + + array + connOptions + + + resourceref + hconn + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_connx + (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. + + + + + &reftitle.parameters; + + + + + qManagerName + + + Name of queue manager. + Name of the queueu manager the application wishes to connect. + + + + + connOps + + + Options that control the action of function + See also the MQCNO structure. + + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_connx</function> + example + + + 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
\n", $comp_code, $reason, mqseries_strerror($reason)); + exit; + } + +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_disc + + + + + + diff --git a/reference/mqseries/functions/mqseries-disc.xml b/reference/mqseries/functions/mqseries-disc.xml new file mode 100644 index 0000000000..06c5a29529 --- /dev/null +++ b/reference/mqseries/functions/mqseries-disc.xml @@ -0,0 +1,128 @@ + + + + + mqseries_disc + MQSeries MQDISC + + + + &reftitle.description; + + mqseries_disc + + resource + hconn + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_disc + (MQDISC) call breaks the connection between the queue manager and the + application program, and is the inverse of the + mqseries_conn + (MQCONN) or + mqseries_connx + (MQCONNX) call. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_disc</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + } +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_conn + mqseries_connx + + + + + + diff --git a/reference/mqseries/functions/mqseries-get.xml b/reference/mqseries/functions/mqseries-get.xml new file mode 100644 index 0000000000..df519e1c3d --- /dev/null +++ b/reference/mqseries/functions/mqseries-get.xml @@ -0,0 +1,218 @@ + + + + + mqseries_get + MQSeries MQGET + + + + &reftitle.description; + + mqseries_get + + resource + hconn + + + resource + hobj + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_get + (MQGET) call retrieves a message from a local queue that has been opened + using the + mqseries_open + (MQOPEN) call + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + hObj + + + Object handle. + This handle represents the object to be used. + + + + + md + + + Message descriptor (MQMD). + + + + + gmo + + + Get message options (MQGMO). + + + + + bufferLength + + + Expected length of the result buffer + + + + + msg + + + + Buffer holding the message that was retreived from the object. + + + + + + data_length + + + Actual buffer length + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_getx</function> + example + + + '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
", $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) + +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_conn + mqseries_connx + mqseries_open + mqseries_put + + + + + + diff --git a/reference/mqseries/functions/mqseries-inq.xml b/reference/mqseries/functions/mqseries-inq.xml new file mode 100644 index 0000000000..28096f7995 --- /dev/null +++ b/reference/mqseries/functions/mqseries-inq.xml @@ -0,0 +1,216 @@ + + + + + mqseries_inq + MQSeries MQINQ + + + + &reftitle.description; + + mqseries_inq + + resource + hconn + + + resource + hobj + + + int + selectorCount + + + array + selectors + + + int + intAttrCount + + + resourceref + intAttr + + + int + charAttrLength + + + resourceref + charAttr + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_inq + (MQINQ) call returns an array of integers and a set of character strings + containing the attributes of an object. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + hObj + + + Object handle. + This handle represents the object to be used. + + + + + selectorCount + + + Count of selectors. + + + + + selectors + + + Array of attribute selectors. + + + + + intAttrLength + + + Count of integer attributes. + + + + + intAttr + + + Array of integer attributes. + + + + + charAttrLength + + + Length of character attributes buffer. + + + + + charAttr + + + Character attributes. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_inq</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + } else { + echo "INQ QManager name result ".$char_attr."
\n"; + } +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_conn + mqseries_connx + mqseries_open + + + + + + diff --git a/reference/mqseries/functions/mqseries-open.xml b/reference/mqseries/functions/mqseries-open.xml new file mode 100644 index 0000000000..0725382737 --- /dev/null +++ b/reference/mqseries/functions/mqseries-open.xml @@ -0,0 +1,167 @@ + + + + + mqseries_open + MQSeries MQOPEN + + + + &reftitle.description; + + mqseries_open + + resource + hconn + + + array + objDesc + + + int + option + + + resourceref + hobj + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_open + (MQOPEN) call establishes access to an object. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + objDesc + + + Object descriptor. (MQOD) + + + + + options + + + Options that control the action of the function. + + + + + hObj + + + Object handle. + This handle represents the object to be used. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_open</function> + example + + + '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
\n", $comp_code, $reason, mqseries_strerror($reason)); + exit; + } +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_close + + + + + + diff --git a/reference/mqseries/functions/mqseries-put.xml b/reference/mqseries/functions/mqseries-put.xml new file mode 100644 index 0000000000..4e33ea91f5 --- /dev/null +++ b/reference/mqseries/functions/mqseries-put.xml @@ -0,0 +1,195 @@ + + + + + mqseries_put + MQSeries MQPUT + + + + &reftitle.description; + + mqseries_put + + resource + hconn + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_put + (MQPUT) call puts a message on a queue or distribution list. The queue or + distribution list must already be open. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + hObj + + + Object handle. + This handle represents the object to be used. + + + + + md + + + Message descriptor (MQMD). + + + + + pmo + + + Put message options (MQPMO). + + + + + message + + + The actual message to put onto the queue. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_put</function> + example + + + '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
\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); + +?> +]]> + + + + + + + &reftitle.seealso; + + + mqseries_conn + mqseries_connx + mqseries_open + mqseries_get + + + + + + diff --git a/reference/mqseries/functions/mqseries-put1.xml b/reference/mqseries/functions/mqseries-put1.xml new file mode 100644 index 0000000000..aa4f0da0c6 --- /dev/null +++ b/reference/mqseries/functions/mqseries-put1.xml @@ -0,0 +1,167 @@ + + + + + mqseries_put1 + MQSeries MQPUT1 + + + + &reftitle.description; + + mqseries_put1 + + resource + hconn + + + resourceref + objDesc + + + resourceref + msgDesc + + + resourceref + pmo + + + string + buffer + + + resourceref + compCode + + + resourceref + reason + + + + The + mqseries_put1 + (MQPUT1) call puts one message on a queue. The queue need not be open. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + objDesc + + + Object descriptor. (MQOD) + + This is a structure which identifies the queue to which the message is + added. + + + + + + msgDesc + + + Message descriptor (MQMD). + + + + + pmo + + + Put message options (MQPMO). + + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_put1</function> + example + + + +]]> + + + + + + + &reftitle.seealso; + + + mqseries_conn + mqseries_connx + mqseries_open + mqseries_get + + + + + + diff --git a/reference/mqseries/functions/mqseries-set.xml b/reference/mqseries/functions/mqseries-set.xml new file mode 100644 index 0000000000..2a4928bb12 --- /dev/null +++ b/reference/mqseries/functions/mqseries-set.xml @@ -0,0 +1,120 @@ + + + + + mqseries_set + MQSeries MQSET + + + + &reftitle.description; + + mqseries_set + + resource + hconn + + + resourceref + compCode + + + resourceref + reason + + + + The mqseries_set + (MQSET) call is used to change the attributes of an object represented by a + handle. The object must be a queue. + + + + + &reftitle.parameters; + + + + + hConn + + + Connection handle. + This handle represents the connection to the queue manager. + + + + + compCode + + + Completion code. + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + &return.void; + + + + &reftitle.examples; + + + + <function>mqseries_set</function> + example + + + +]]> + + + + + + + &reftitle.seealso; + + + mqseries_inq + + + + + + diff --git a/reference/mqseries/functions/mqseries-strerror.xml b/reference/mqseries/functions/mqseries-strerror.xml new file mode 100644 index 0000000000..a699158a4f --- /dev/null +++ b/reference/mqseries/functions/mqseries-strerror.xml @@ -0,0 +1,94 @@ + + + + + mqseries_strerror + Returns the error message corresponding to a result code (MQRC). + + + + &reftitle.description; + + string + mqseries_strerror + + int + reason + + + + mqseries_strerror + returns the message that correspond to the reason result code. + + + + + &reftitle.parameters; + + + + + reason + + + Reason code qualifying the compCode. + + + + + + + + &reftitle.returnvalues; + string representation of the reason code message. + + + + &reftitle.examples; + + + + <function>mqseries_strerror</function> + example + + +\n", $comp_code, $reason, mqseries_strerror($reason)); + exit; + } +?> +]]> + + &example.outputs; + + + + + + + + + diff --git a/reference/mqseries/ini.xml b/reference/mqseries/ini.xml new file mode 100644 index 0000000000..c23a5de3d5 --- /dev/null +++ b/reference/mqseries/ini.xml @@ -0,0 +1,28 @@ + + +
+ &reftitle.runtime; + &extension.runtime; + No extra configuration parameters exsists. +
+ + diff --git a/reference/mqseries/reference.xml b/reference/mqseries/reference.xml new file mode 100644 index 0000000000..ce528514ac --- /dev/null +++ b/reference/mqseries/reference.xml @@ -0,0 +1,29 @@ + + + + + mqseries &Functions; + &reference.mqseries.entities.functions; + + + + diff --git a/reference/mqseries/resources.xml b/reference/mqseries/resources.xml new file mode 100644 index 0000000000..50a014a46b --- /dev/null +++ b/reference/mqseries/resources.xml @@ -0,0 +1,36 @@ + + +
+ &reftitle.resources; + + This extension defines a connection and object_handle resources. + + + The mqseries_conn and mqseries_connx define the + connectionn handles. + + + The mqseries_open defines the object handle. + +
+ + diff --git a/reference/mqseries/setup.xml b/reference/mqseries/setup.xml new file mode 100644 index 0000000000..e821489f38 --- /dev/null +++ b/reference/mqseries/setup.xml @@ -0,0 +1,67 @@ + + + + + &reftitle.setup; + + +
+ &reftitle.required; + + A working IBM WebSphere MQ installation. If building the extention the SDK + for IBM WebSphere MQ is also required. + + + + 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. + + +
+ Installation requirements on non windows platforms + Build the extention and put it in the PHP extention directory. +
+
+ Installation requirements on Windows + No additional requirements. +
+ +
+ + + + &reference.mqseries.configure; + + + + &reference.mqseries.ini; + + + + &reference.mqseries.resources; + + + + + +