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

548 lines
26 KiB
HTML
Raw 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="Retrieve Triggered Cache Manager Acknowledgment Target Description (QzhtRtvTCMAckTargetDesc) 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_qzhtrtvtcmacktargetdesc" />
<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>Retrieve Triggered Cache Manager Acknowledgment Target Description
(QzhtRtvTCMAckTargetDesc) API</title>
</head>
<body id="rzaieapi_qzhtrtvtcmacktargetdesc"><a name="rzaieapi_qzhtrtvtcmacktargetdesc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Retrieve Triggered Cache Manager Acknowledgment Target Description
(QzhtRtvTCMAckTargetDesc) 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%">receiver variable</td>
<td valign="top" width="31.060606060606062%">Output</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 receiver 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%">receiver 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 QzhtRtvTCMAckTargetDesc API to retrieve information from acknowledgment
target descriptions associated with triggered cache manager servers. 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>receiver variable</strong></dt>
<dd>OUTPUT: CHAR(*)<p> The variable used to return acknowledgment target description
information. See Acknowledgment target description formats for more information.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>length of receiver variable</strong></dt>
<dd>INPUT: BINARY(4) <p>The number of bytes that the calling program provides
for Receiver variable. This value must be greater than or equal to 8.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>receiver variable format</strong></dt>
<dd>INPUT: CHAR(8) <p>The format name of Receiver variable data. The following
values must be used:</p>
<ul><li>ATDG0100: Basic information format for an acknowledgment target description.</li>
<li>ATDG0200: Detailed information format for an *HTTP1 type acknowledgment
target description.</li>
<li>ATDG0210: 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 from which information is retrieved (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 retrieved acknowledgment
target description information (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="atdg0100_format"><a name="atdg0100_format"><!-- --></a><h2 class="topictitle2">ATDG0100 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="d0e179">Offset</th>
<th rowspan="2" valign="top" id="d0e181">Type</th>
<th rowspan="2" valign="top" id="d0e183">Field</th>
</tr>
<tr><th valign="top" id="d0e186">Dec</th>
<th valign="top" id="d0e188">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e179 d0e186 ">0</td>
<td valign="top" headers="d0e179 d0e188 ">0</td>
<td valign="top" headers="d0e181 ">Binary(4)</td>
<td valign="top" headers="d0e183 ">Bytes returned</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">4</td>
<td valign="top" headers="d0e179 d0e188 ">4</td>
<td valign="top" headers="d0e181 ">Binary(4)</td>
<td valign="top" headers="d0e183 ">Bytes available</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">8</td>
<td valign="top" headers="d0e179 d0e188 ">8</td>
<td valign="top" headers="d0e181 ">Char(32)</td>
<td valign="top" headers="d0e183 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">40</td>
<td valign="top" headers="d0e179 d0e188 ">28</td>
<td valign="top" headers="d0e181 ">Char(32)</td>
<td valign="top" headers="d0e183 ">Acknowledgement target description name</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">72</td>
<td valign="top" headers="d0e179 d0e188 ">40</td>
<td valign="top" headers="d0e181 ">Char(10)</td>
<td valign="top" headers="d0e183 ">Acknowledgement target type</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">82</td>
<td valign="top" headers="d0e179 d0e188 ">52</td>
<td valign="top" headers="d0e181 ">Char(2)</td>
<td valign="top" headers="d0e183 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">84</td>
<td valign="top" headers="d0e179 d0e188 ">56</td>
<td valign="top" headers="d0e181 ">Binary(4)</td>
<td valign="top" headers="d0e183 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">88</td>
<td valign="top" headers="d0e179 d0e188 ">58</td>
<td valign="top" headers="d0e181 ">Binary(4)</td>
<td valign="top" headers="d0e183 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e179 d0e186 ">92</td>
<td valign="top" headers="d0e179 d0e188 ">5C</td>
<td valign="top" headers="d0e181 ">Binary(4)</td>
<td valign="top" headers="d0e183 ">Initial state</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="atdg0100_field_descriptions"><a name="atdg0100_field_descriptions"><!-- --></a><h2 class="topictitle2">ATDG0100 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Bytes available</strong></dt>
<dd>The number of information bytes available for return to the caller of
the API.<div class="note"><span class="notetitle">Note:</span> If this value is greater than the value of Bytes returned, the
receiver variable was not large enough to return all information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Bytes returned</strong></dt>
<dd>The number of information bytes returned to the caller of the API.</dd>
</dl>
<dl><dt class="dlterm"><strong>Acknowledgement target description name</strong></dt>
<dd>The acknowledgment target description name (left justified and padded
with blanks if necessary).</dd>
</dl>
<dl><dt class="dlterm"><strong>Acknowledgement target type</strong></dt>
<dd>The acknowledgment target description type (left justified and padded
with blanks if necessary). The value returned is one of the special values
below.<p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*HTTP1</strong></dt>
<dd>QZHT_HTTP_TYPE1</dd>
</dl>
<dl><dt class="dlterm"><strong>*HTTP2</strong></dt>
<dd>QZHT_HTTP_TYPE2</dd>
</dl>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Indicates if the description is a current default acknowledgment target
description for the triggered cache manager server specified in Server name.
The returned value equals one of the special values described 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.873015873015872%"><strong>0</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
is a current default acknowledgment target description for this server.</td>
</tr>
<tr><td valign="top" width="15.873015873015872%"><strong>-1</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_DEFAULT: The description is not a current default
acknowledgment target description.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> Multiple default acknowledgment target descriptions are possible.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Initial state</strong></dt>
<dd>Indicates if the triggered cache manager server message processor, for
this acknowledgment target, is enabled or disabled at server startup. The
returned value equals one of the special values described 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.873015873015872%"><strong>0</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The message processor
is enabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.873015873015872%"><strong>-1</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_DEFAULT: The message processor is disabled at server
startup.</td>
</tr>
</tbody>
</table>
</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 sending completion messages to this acknowledgment target. The value
must be greater than 0 and less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>).</dd>
</dl>
<dl><dt class="dlterm"><strong>Server name</strong></dt>
<dd>The name of the triggered cache manager server for which the description
is associated (left justified and padded with blanks if necessary).</dd>
</dl>
</div>
</div>
<div class="nested1" id="atdg0200_format"><a name="atdg0200_format"><!-- --></a><h2 class="topictitle2">ATDG0200 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="d0e408">Offset</th>
<th rowspan="2" valign="top" id="d0e410">Type</th>
<th rowspan="2" valign="top" id="d0e412">Field</th>
</tr>
<tr><th valign="top" id="d0e415">Dec</th>
<th valign="top" id="d0e417">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e408 d0e415 ">0</td>
<td valign="top" headers="d0e408 d0e417 ">0</td>
<td valign="top" headers="d0e410 ">&nbsp;</td>
<td valign="top" headers="d0e412 ">Everything from ATDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e408 d0e415 ">96</td>
<td valign="top" headers="d0e408 d0e417 ">60</td>
<td valign="top" headers="d0e410 ">Char(256)</td>
<td valign="top" headers="d0e412 ">HTTP IP interface</td>
</tr>
<tr><td valign="top" headers="d0e408 d0e415 ">352</td>
<td valign="top" headers="d0e408 d0e417 ">160</td>
<td valign="top" headers="d0e410 ">Binary(4)</td>
<td valign="top" headers="d0e412 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e408 d0e415 ">356</td>
<td valign="top" headers="d0e408 d0e417 ">164</td>
<td valign="top" headers="d0e410 ">Binary(4)</td>
<td valign="top" headers="d0e412 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e408 d0e415 ">360</td>
<td valign="top" headers="d0e408 d0e417 ">168</td>
<td valign="top" headers="d0e410 ">Binary(4)</td>
<td valign="top" headers="d0e412 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e408 d0e415 ">364</td>
<td valign="top" headers="d0e408 d0e417 ">16C</td>
<td valign="top" headers="d0e410 ">Binary(4)</td>
<td valign="top" headers="d0e412 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e408 d0e415 ">368</td>
<td valign="top" headers="d0e408 d0e417 ">170</td>
<td valign="top" headers="d0e410 ">Binary(4)</td>
<td valign="top" headers="d0e412 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e408 d0e415 ">&nbsp;</td>
<td valign="top" headers="d0e408 d0e417 ">&nbsp;</td>
<td valign="top" headers="d0e410 ">Char(*)</td>
<td valign="top" headers="d0e412 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="atdg0200_field_descriptions"><a name="atdg0200_field_descriptions"><!-- --></a><h2 class="topictitle2">ATDG0200 format field descriptions</h2>
<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) or dotted
address (for example, 192.168.3.57).</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. <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.873015873015872%"><strong>1</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.873015873015872%"><strong>0</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after data transfer.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP TCP port</strong></dt>
<dd>The TCP port of HTTP Server acknowledgment target. The value must be greater
than 0 and less than 65536.<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 defines the root of this acknowledgment
target (left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All completion
message requests sent to the acknowledgment target are prepended with this
path.</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.</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.</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.873015873015872%"><strong>0</strong></td>
<td valign="top" width="84.12698412698413%">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>
</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="d0e596">Offset</th>
<th rowspan="2" valign="top" id="d0e598">Type</th>
<th rowspan="2" valign="top" id="d0e600">Field</th>
</tr>
<tr><th valign="top" id="d0e603">Dec</th>
<th valign="top" id="d0e605">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e596 d0e603 ">0</td>
<td valign="top" headers="d0e596 d0e605 ">0</td>
<td valign="top" headers="d0e598 ">&nbsp;</td>
<td valign="top" headers="d0e600 ">Everything from ATDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e596 d0e603 ">96</td>
<td valign="top" headers="d0e596 d0e605 ">60</td>
<td valign="top" headers="d0e598 ">Char(32)</td>
<td valign="top" headers="d0e600 ">HTTP host</td>
</tr>
<tr><td valign="top" headers="d0e596 d0e603 ">128</td>
<td valign="top" headers="d0e596 d0e605 ">80</td>
<td valign="top" headers="d0e598 ">Binary(4)</td>
<td valign="top" headers="d0e600 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e596 d0e603 ">132</td>
<td valign="top" headers="d0e596 d0e605 ">84</td>
<td valign="top" headers="d0e598 ">Binary(4)</td>
<td valign="top" headers="d0e600 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e596 d0e603 ">136</td>
<td valign="top" headers="d0e596 d0e605 ">88</td>
<td valign="top" headers="d0e598 ">Binary(4)</td>
<td valign="top" headers="d0e600 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e596 d0e603 ">140</td>
<td valign="top" headers="d0e596 d0e605 ">8C</td>
<td valign="top" headers="d0e598 ">Binary(4)</td>
<td valign="top" headers="d0e600 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e596 d0e603 ">144</td>
<td valign="top" headers="d0e596 d0e605 ">90</td>
<td valign="top" headers="d0e598 ">Binary(4)</td>
<td valign="top" headers="d0e600 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e596 d0e603 ">&nbsp;</td>
<td valign="top" headers="d0e596 d0e605 ">&nbsp;</td>
<td valign="top" headers="d0e598 ">Char(*)</td>
<td valign="top" headers="d0e600 ">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><dl><dt class="dlterm"><strong>HTTP host</strong></dt>
<dd>The name of a host description referenced by the acknowledgment target
description and used, at server startup, to obtain information about the system
hosting an HTTP server accepting completion messages. The value must be a
host description name (left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> See
HTTP TCP port for more information. The referenced host description may or
may not currently exist. It is possible that it was removed or associated
with a different triggered cache manager server after this acknowledgment
target description was last modified.</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 transfer. The value must equal one of the special values described 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.873015873015872%"><strong>1</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.873015873015872%"><strong>0</strong></td>
<td valign="top" width="84.12698412698413%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
closed after data transfer.</td>
</tr>
</tbody>
</table>
</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.<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 defines the root of this acknowledgment
target (left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All requests
to send completion messages to this acknowledgment target are prepended with
this path.</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.</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.</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. <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.873015873015872%"><strong>0</strong></td>
<td valign="top" width="84.12698412698413%">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>
</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>TCM7032 E</strong></dt>
<dd>Receiver variable format is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7034 E</strong></dt>
<dd>Length of receiver variable is not valid for the specified format.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7035 E</strong></dt>
<dd>Server parameter is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7036 E</strong></dt>
<dd>Description parameter is not valid.</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 E</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 E</strong></dt>
<dd>A configuration file for triggered cache manager server &amp;1 was not
found.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7290 E</strong></dt>
<dd>&amp;1 &amp;2 was not found for triggered cache manager server &amp;3.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink