friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaieapi_qzhtchgtcmacktargetdesc.htm

780 lines
38 KiB
HTML
Raw Permalink Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="topic" />
<meta name="DC.Title" content="Change Triggered Cache Manager Acknowledgment Target Description (QzhtChgTCMAckTargetDesc) API" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzaieapi_qzhtchgtcmacktargetdesc" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Change Triggered Cache Manager Acknowledgment Target Description (QzhtChgTCMAckTargetDesc)
API</title>
</head>
<body id="rzaieapi_qzhtchgtcmacktargetdesc"><a name="rzaieapi_qzhtchgtcmacktargetdesc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Change Triggered Cache Manager Acknowledgment Target Description (QzhtChgTCMAckTargetDesc)
API</h1>
<div><div class="important"><span class="importanttitle">Important:</span> Information
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
It is recommended that you install the latest PTFs to upgrade to the latest
level of the HTTP Server for i5/OS. Some of the topics documented here are
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
<td valign="top" width="31.313131313131315%">request variable</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(*)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
<td valign="top" width="31.313131313131315%">length of request variable</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Binary(4)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
<td valign="top" width="31.313131313131315%">request variable format</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(8)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
<td valign="top" width="31.313131313131315%">server name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(32)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">5</td>
<td valign="top" width="31.313131313131315%">description name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(32)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">6</td>
<td valign="top" width="31.313131313131315%">error code</td>
<td valign="top" width="31.060606060606062%">I/O</td>
<td valign="top" width="31.313131313131315%">Char(*)</td>
</tr>
<tr><td colspan="4" valign="top">Library Name/Service Program: QTCM/QZHTINCONF</td>
</tr>
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
</tr>
</tbody>
</table>
</div>
<p>Use the QzhtChgTCMAckTargetDesc API to change acknowledgment target descriptions
associated with triggered cache manager servers. Changes made to acknowledgment
target descriptions are utilized by all trigger handler descriptions referencing
them (the next time the servers are started). The API is a callable service
implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM
*LIB. </p>
<p>The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.</p>
</div>
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
<div><ul><li>*IOSYSCFG special authority</li>
</ul>
</div>
</div>
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
<div><dl><dt class="dlterm"><strong>request variable</strong></dt>
<dd>INPUT: CHAR(*) The variable used to pass the information used to change
an acknowledgment target description.</dd>
</dl>
<dl><dt class="dlterm"><strong>length of request variable</strong></dt>
<dd>INPUT: BINARY(4) <p>The number of bytes that the calling program provides
for request variable.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>request variable format</strong></dt>
<dd>INPUT: CHAR(8) <p>The format name of the Request variable data. The following
values must be used:</p>
<ul><li>ATDP0100: Basic information format for an acknowledgment target description.</li>
<li>ATDP0200: Detailed information format for an *HTTP1 type acknowledgment
target description.</li>
<li>ATDP0210: Detailed information format for an *HTTP2 type acknowledgment
target description.</li>
</ul>
</dd>
</dl>
<dl><dt class="dlterm"><strong>server name</strong></dt>
<dd>INPUT: CHAR(32) <p>The name used to identify the triggered cache manager
server for which the description is changed (left justified and padded with
blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>description name</strong></dt>
<dd>INPUT: CHAR(32) <p>The name used to identify the changed acknowledgment
target description (left justified and padded with blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>error code</strong></dt>
<dd>I/O: CHAR(*) <p>The structure in which to return error information.</p>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="atdp0100_format"><a name="atdp0100_format"><!-- --></a><h2 class="topictitle2">ATDP0100 format</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e177">Offset</th>
<th rowspan="2" valign="top" id="d0e179">Type</th>
<th rowspan="2" valign="top" id="d0e181">Field</th>
</tr>
<tr><th valign="top" id="d0e184">Dec</th>
<th valign="top" id="d0e186">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e177 d0e184 ">0</td>
<td valign="top" headers="d0e177 d0e186 ">0</td>
<td valign="top" headers="d0e179 ">Char(32)</td>
<td valign="top" headers="d0e181 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e177 d0e184 ">32</td>
<td valign="top" headers="d0e177 d0e186 ">20</td>
<td valign="top" headers="d0e179 ">Char(32)</td>
<td valign="top" headers="d0e181 ">Acknowledgement target description name</td>
</tr>
<tr><td valign="top" headers="d0e177 d0e184 ">64</td>
<td valign="top" headers="d0e177 d0e186 ">40</td>
<td valign="top" headers="d0e179 ">Char(10)</td>
<td valign="top" headers="d0e181 ">Acknowledgement target type</td>
</tr>
<tr><td valign="top" headers="d0e177 d0e184 ">74</td>
<td valign="top" headers="d0e177 d0e186 ">4A</td>
<td valign="top" headers="d0e179 ">Char(2)</td>
<td valign="top" headers="d0e181 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e177 d0e184 ">76</td>
<td valign="top" headers="d0e177 d0e186 ">4C</td>
<td valign="top" headers="d0e179 ">Binary(4)</td>
<td valign="top" headers="d0e181 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e177 d0e184 ">80</td>
<td valign="top" headers="d0e177 d0e186 ">50</td>
<td valign="top" headers="d0e179 ">Binary(4)</td>
<td valign="top" headers="d0e181 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e177 d0e184 ">84</td>
<td valign="top" headers="d0e177 d0e186 ">54</td>
<td valign="top" headers="d0e179 ">Binary(4)</td>
<td valign="top" headers="d0e181 ">Initial state</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="atdp0100_field_descriptions"><a name="atdp0100_field_descriptions"><!-- --></a><h2 class="topictitle2">ATDP0100 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> Acknowledgment target descriptions are added using default values for
all unspecified values according to the type specified by Acknowledgment target
type). See other acknowledgment target description formats for details regarding
these default values.</div>
<dl><dt class="dlterm"><strong>Acknowledgement target description name</strong></dt>
<dd>The name used by the new acknowledgment target description (left justified
and padded with blanks if necessary). The value must be a description name,
or be one of the special values described below.<p>Special values and their
meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current name is not changed.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> Acknowledgment target description names must be unique
for each triggered cache manager server.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Acknowledgement target type</strong></dt>
<dd>The added acknowledgment target description type (left justified and padded
with blanks if necessary). The value must be one of the special values described
below.<p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The description is not changed to a different type.</dd>
</dl>
<dl><dt class="dlterm"><strong>*HTTP1</strong></dt>
<dd>QZHT_HTTP_TYPE1: An *HTTP1 type is added.</dd>
</dl>
<dl><dt class="dlterm"><strong>*HTTP2</strong></dt>
<dd>QZHT_HTTP_TYPE2: An *HTTP2 type is added.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> If a type is specified, that is different than the current
type, certain information is discarded if it cannot be mapped to values for
the new description type. See other acknowledgment target description formats
for details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Specifies if the new description is the default acknowledgment target
description for the triggered cache manager server specified in Server name.
The value must equal one of the special values described below. The default
value is 0 (QZHT_NO). <p>Special values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
the default cache target description for this server.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
is not the default cache target description.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is be changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> Multiple default acknowledgment target descriptions are allowed.
Trigger handler descriptions, added or changed using the *DEFAULT special
value, reference all acknowledgment target descriptions designated as default
at the time the trigger handler descriptions are added or changed.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Initial state</strong></dt>
<dd>Specifies the state that the triggered cache manager server request processor,
for this acknowledgment target, is in at server startup. The value must equal
one of the special values described below. The default value is 1 (QZHT_ENABLED).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
is enabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request processor
is disabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The state of a acknowledgment target request processor can be
changed while the triggered cache manager server is active by using the -<em>chack</em> command
in a trigger message.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Number of threads</strong></dt>
<dd>The number of concurrent threads the triggered cache manager server spawns
when processing requests sent to this acknowledgment target. The value must
be greater that 0 and less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>),
or equal to one of the special values described below. The default value is
5. <p>Special values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Server name</strong></dt>
<dd>The name used to identify the triggered cache manager server for which
the description is associated (left justified and padded with blanks if necessary).
The value must be a server name, or one of the special values described below.
If a server name is specified, that is different than the one with which the
description is currently associated, it is removed from its current association
and added for the new server.<p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The current server association is not changed.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> An escape message is sent if the description is removed
from its current association (while being referenced by other descriptions).</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="atdp0200_format"><a name="atdp0200_format"><!-- --></a><h2 class="topictitle2">ATDP0200 format</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e451">Offset</th>
<th rowspan="2" valign="top" id="d0e453">Type</th>
<th rowspan="2" valign="top" id="d0e455">Field</th>
</tr>
<tr><th valign="top" id="d0e458">Dec</th>
<th valign="top" id="d0e460">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e451 d0e458 ">0</td>
<td valign="top" headers="d0e451 d0e460 ">0</td>
<td valign="top" headers="d0e453 ">Char(256)</td>
<td valign="top" headers="d0e455 ">Everything from ATDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e451 d0e458 ">88</td>
<td valign="top" headers="d0e451 d0e460 ">58</td>
<td valign="top" headers="d0e453 ">Binary(4)</td>
<td valign="top" headers="d0e455 ">HTTP IP interface</td>
</tr>
<tr><td valign="top" headers="d0e451 d0e458 ">344</td>
<td valign="top" headers="d0e451 d0e460 ">158</td>
<td valign="top" headers="d0e453 ">Binary(4)</td>
<td valign="top" headers="d0e455 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e451 d0e458 ">348</td>
<td valign="top" headers="d0e451 d0e460 ">15C</td>
<td valign="top" headers="d0e453 ">Binary(4)</td>
<td valign="top" headers="d0e455 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e451 d0e458 ">352</td>
<td valign="top" headers="d0e451 d0e460 ">160</td>
<td valign="top" headers="d0e453 ">Binary(4)</td>
<td valign="top" headers="d0e455 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e451 d0e458 ">356</td>
<td valign="top" headers="d0e451 d0e460 ">164</td>
<td valign="top" headers="d0e453 ">Binary(4)</td>
<td valign="top" headers="d0e455 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e451 d0e458 ">360</td>
<td valign="top" headers="d0e451 d0e460 ">168</td>
<td valign="top" headers="d0e453 ">Binary(4)</td>
<td valign="top" headers="d0e455 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e451 d0e458 ">&nbsp;</td>
<td valign="top" headers="d0e451 d0e460 ">&nbsp;</td>
<td valign="top" headers="d0e453 ">Char(*)</td>
<td valign="top" headers="d0e455 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="atdp0200_field_descriptions"><a name="atdp0200_field_descriptions"><!-- --></a><h2 class="topictitle2">ATDP0200 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *HTTP1, all information currently
stored for the description, that is not mapped to one the following entries,
is discarded.</div>
<dl><dt class="dlterm"><strong>HTTP IP interface</strong></dt>
<dd>The IP host name or address of the system hosting an HTTP server that
accepts completion messages (left justified and padded with blanks if necessary).
The value must be a host name (for example, server.mycompany.com), dotted
address (for example, 192.168.3.57), or one of the special values described
below. If a host name is specified, it must use proper naming conventions
as defined by RFC 1034, Domain Names - Concepts and Facilities. If a dotted
address is specified, it must use proper IP version 4 address conventions
as defined by RFC 791, Internet Protocol. The default value is 127.0.0.1,
the local system loopback interface. <p>Special values and their meanings
are as follows:</p>
<dl><dt class="dlterm"><strong>*DEFAULT</strong></dt>
<dd>QZHT_DEFAULT_CHAR: The default value is used.</dd>
</dl>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e569">If the current type is:</th>
<th valign="top" id="d0e571">&nbsp;</th>
<th valign="top" id="d0e572">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e569 ">*HTTP1</td>
<td valign="top" headers="d0e571 ">use current HTTP IP interface value</td>
<td valign="top" headers="d0e572 ">No change is made.</td>
</tr>
<tr><td valign="top" headers="d0e569 ">*HTTP2</td>
<td valign="top" headers="d0e571 ">use IP interface value from the host description currently
referenced by HTTP host </td>
<td valign="top" headers="d0e572 ">An exception occurs if the referenced description does
not exist. Refers to ATDP0210 format.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP keepalive</strong></dt>
<dd>Specifies if connections to HTTP Server are kept open for reuse after
data is transferred. The value must equal one of the special values described
below. The default value is 0 (QZHT_DISABLED). <p>Special values and their
meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after messages are sent.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after messages are sent.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> HTTP Server must support keepalive for this option to work properly.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP TCP port</strong></dt>
<dd>The TCP port number upon which HTTP Server listens for incoming requests.
The value must be greater than 0 and less than 65536, or equal to one of the
special values described below. The default value is 80. <p>Special values
and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The TCP port number is used in combination with the IP host
name or address in HTTP IP interface to establish communication with HTTP
Server acknowledgment target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP URI root</strong></dt>
<dd>The path of HTTP Server URI that is the root of this acknowledgment target
(left justified and padded with blanks if necessary). The value must be a
path acceptable to HTTP Server. The default path is / .<p>If Offset to HTTP
URI root equals -2 (QZHT_NO_CHANGE), the current path is not changed.</p>
<div class="note"><span class="notetitle">Note:</span> All
completion message requests sent to the acknowledgment target are prepended
with this path. If the value is null, Offset to HTTP URI root must equal 0
(QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE). See Offset to HTTP
URI root for more details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP URI root</strong></dt>
<dd>The length of the information for the HTTP URI root entry.<div class="note"><span class="notetitle">Note:</span> If Offset
to HTTP URI root equals 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE),
this value must equal 0. If Offset to HTTP URI root equals 0 (QZHT_NONE),
-1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE), this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the request variable to the HTTP URI
root data, in bytes. The value must be greater than 0, or equal to one of
the special values defined below.<p>Special values and their meanings are
as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used for HTTP URI
root.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current path for HTTP URI root is
not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Timeout</strong></dt>
<dd>The number of seconds the triggered cache manager server waits before
canceling a read operation on sockets and ending transactions, with the HTTP
host, in error. The value must be greater than 0 and less than 2<sup>31</sup> (or
2.147x10<sup>9</sup>), or equal to one of the special values described below.
The default value is 0 (QZHT_DISABLED).<p>Special values and their meanings
are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The time out operation
is disabled. The triggered cache manager server should never cancel a read
operation.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="atdp0210_format"><a name="atdp0210_format"><!-- --></a><h2 class="topictitle2">ATDP0210 format</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e759">Offset</th>
<th rowspan="2" valign="top" id="d0e761">Type</th>
<th rowspan="2" valign="top" id="d0e763">Field</th>
</tr>
<tr><th valign="top" id="d0e766">Dec</th>
<th valign="top" id="d0e768">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e759 d0e766 ">0</td>
<td valign="top" headers="d0e759 d0e768 ">0</td>
<td valign="top" headers="d0e761 ">&nbsp;</td>
<td valign="top" headers="d0e763 ">Everything from ATDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e759 d0e766 ">88</td>
<td valign="top" headers="d0e759 d0e768 ">58</td>
<td valign="top" headers="d0e761 ">Char(32)</td>
<td valign="top" headers="d0e763 ">HTTP host</td>
</tr>
<tr><td valign="top" headers="d0e759 d0e766 ">120</td>
<td valign="top" headers="d0e759 d0e768 ">78</td>
<td valign="top" headers="d0e761 ">Binary(4)</td>
<td valign="top" headers="d0e763 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e759 d0e766 ">124</td>
<td valign="top" headers="d0e759 d0e768 ">7C</td>
<td valign="top" headers="d0e761 ">Binary(4)</td>
<td valign="top" headers="d0e763 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e759 d0e766 ">128</td>
<td valign="top" headers="d0e759 d0e768 ">80</td>
<td valign="top" headers="d0e761 ">Binary(4)</td>
<td valign="top" headers="d0e763 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e759 d0e766 ">132</td>
<td valign="top" headers="d0e759 d0e768 ">84</td>
<td valign="top" headers="d0e761 ">Binary(4)</td>
<td valign="top" headers="d0e763 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e759 d0e766 ">136</td>
<td valign="top" headers="d0e759 d0e768 ">88</td>
<td valign="top" headers="d0e761 ">Binary(4)</td>
<td valign="top" headers="d0e763 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e759 d0e766 ">&nbsp;</td>
<td valign="top" headers="d0e759 d0e768 ">&nbsp;</td>
<td valign="top" headers="d0e761 ">Char(*)</td>
<td valign="top" headers="d0e763 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="atdp0210_field_descriptions"><a name="atdp0210_field_descriptions"><!-- --></a><h2 class="topictitle2">ATDP0210 format field descriptions</h2>
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *HTTP2, all information currently
stored for the description, that is not mapped to one the following entries,
is discarded.</div>
<dl><dt class="dlterm"><strong>HTTP host</strong></dt>
<dd>The name of a host description associated with the triggered cache manager
server that is referenced by the new acknowledgment target description and
used later, at server startup, to obtain information about the system hosting
an HTTP server accepting completion messages. The value must be a host description
name, or one of the special values described below (left justified and padded
with blanks if necessary). The default value is to reference the description
currently designated as the default host description for the triggered cache
manager server. <p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*DEFAULT</strong></dt>
<dd>QZHT_DEFAULT_CHAR: The default value is referenced.</dd>
</dl>
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
values for reuse:</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e876">If the current type is:</th>
<th valign="top" id="d0e878">&nbsp;</th>
<th valign="top" id="d0e879">Details</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e876 ">*HTTP1</td>
<td valign="top" headers="d0e878 ">the default host description, currently associated with
the triggered cache manager server is, referenced.</td>
<td valign="top" headers="d0e879 ">&nbsp;</td>
</tr>
<tr><td valign="top" headers="d0e876 ">*HTTP2</td>
<td valign="top" headers="d0e878 ">the description, currently referenced for HTTP host,
is not changed </td>
<td valign="top" headers="d0e879 ">No change is made.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> See HTTP TCP port for more information. An escape message is
sent if the referenced description does not currently exist, or if *DEFAULT
is specified and there is currently no default host description for the server.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP keepalive</strong></dt>
<dd>Specifies if connections to HTTP Server are kept open for reuse after
completion messages are sent. The value must equal one of the special values
described below. The default value is 0 (QZHT_DISABLED). <p>Special values
and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after messages are sent.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after messages are sent.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> HTTP Server must support keepalive for this option to work properly.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP TCP port</strong></dt>
<dd>The TCP port number upon which HTTP Server listens for incoming completion
messages. The value must be greater than 0 and less than 65536, or equal to
one of the special values described below. The default value is 80. <p>Special
values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The TCP port number is used in combination with information
obtained at server startup from the host description specified in HTTP host
to establish communication with HTTP Server acknowledgment target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP URI root</strong></dt>
<dd>The path of HTTP Server URI that is the root of this acknowledgment target
(left justified and padded with blanks if necessary). The value must be a
path acceptable to HTTP Server. The default path is / .<p>If Offset to HTTP
URI root equals -2 (QZHT_NO_CHANGE), the current path is not changed.</p>
<div class="note"><span class="notetitle">Note:</span> All
requests to send completion messages to this acknowledgment target are prepended
with this path. If the value is null, Offset to HTTP URI root must equal 0
(QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE). See Offset to HTTP
URI root for more details.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP URI root</strong></dt>
<dd>The length of the information for the HTTP URI root entry.<div class="note"><span class="notetitle">Note:</span> If Offset
to HTTP URI root equals 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE),
this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the request variable to the HTTP URI
root data, in bytes. The value must be greater than 0, or equal to one of
the special values defined below. <p>Special values and their meanings are
as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default path is used for HTTP URI
root.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current path for HTTP URI root is
not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Timeout</strong></dt>
<dd>The number of seconds the triggered cache manager server waits before
canceling a read operation on sockets and ending transactions, with the HTTP
host, in error. The value must be greater than 0 and less than 2<sup>31</sup> (or
2.147x10<sup>9</sup>), or equal to one of the special values described below.
The default value is 0 (QZHT_DISABLED). <p>Special values and their meanings
are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The time out operation
is disabled. The triggered cache manager server should never cancel a read
operation.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-2</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO_CHANGE: The current value is not changed.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
<div><dl><dt class="dlterm"><strong>TCM7001 E</strong></dt>
<dd>User &amp;1 is not authorized.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7030 E</strong></dt>
<dd>Severe error occurred while addressing parameter list.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7031 E</strong></dt>
<dd>Request variable format is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7033 E</strong></dt>
<dd>Length of request variable is not valid for the specified format.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM703E E</strong></dt>
<dd>Error code parameter is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM70F0 E</strong></dt>
<dd>Unknown error occurred while processing request.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7101 D</strong></dt>
<dd>User QTCM is not authorized to the configuration file for triggered cache
manager server &amp;1.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7190 D</strong></dt>
<dd>A configuration file for triggered cache manager server &amp;1 was not
found.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7222 D</strong></dt>
<dd>A default &amp;1 is not designated for triggered cache manager server &amp;2.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7290 D</strong></dt>
<dd>&amp;1 &amp;2 was not found for triggered cache manager server &amp;3.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7293 D</strong></dt>
<dd>A &amp;1 using the name &amp;2 already exists for triggered cache manager
server &amp;3.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C0 D</strong></dt>
<dd>Triggered cache manager &amp;1 name is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C1 D</strong></dt>
<dd>Triggered cache manager &amp;1 type is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C2 D</strong></dt>
<dd>Triggered cache manager description type &amp;1 cannot be specified when
using data format &amp;2.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C3 D</strong></dt>
<dd>Value passed to offset &amp;1 is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM74C0 D</strong></dt>
<dd>Triggered cache manager server name is not valid.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink