644 lines
32 KiB
HTML
644 lines
32 KiB
HTML
|
<?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="Add Triggered Cache Manager Acknowledgment Target Description (QzhtAddTCMAckTargetDesc) 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_qzhtaddtcmacktargetdesc" />
|
||
|
|
<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>Add Triggered Cache Manager Acknowledgment Target Description (QzhtAddTCMAckTargetDesc)
|
||
|
|
API</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaieapi_qzhtaddtcmacktargetdesc"><a name="rzaieapi_qzhtaddtcmacktargetdesc"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Add Triggered Cache Manager Acknowledgment Target Description (QzhtAddTCMAckTargetDesc)
|
||
|
|
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 or 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%">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 QzhtAddTCMAckTargetDesc API to add new acknowledgment target descriptions
|
||
|
|
to the configurations of triggered cache manager servers. New acknowledgment
|
||
|
|
target descriptions are referenced subsequently, by name, from trigger handler
|
||
|
|
descriptions associated with the same server. New acknowledgment target descriptions
|
||
|
|
are utilized by all trigger handler descriptions, referencing then the next
|
||
|
|
time the servers are restarted. 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(*) <p>The variable used to pass the information used to add
|
||
|
|
a new acknowledgment target description. See Acknowledgment target description
|
||
|
|
formats for more information.</p>
|
||
|
|
</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>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="d0e143">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e145">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e147">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e150">Dec</th>
|
||
|
|
<th valign="top" id="d0e152">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e143 d0e150 ">0</td>
|
||
|
|
<td valign="top" headers="d0e143 d0e152 ">0</td>
|
||
|
|
<td valign="top" headers="d0e145 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e147 ">Server name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e143 d0e150 ">32</td>
|
||
|
|
<td valign="top" headers="d0e143 d0e152 ">20</td>
|
||
|
|
<td valign="top" headers="d0e145 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e147 ">Acknowledgement target description name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e143 d0e150 ">64</td>
|
||
|
|
<td valign="top" headers="d0e143 d0e152 ">40</td>
|
||
|
|
<td valign="top" headers="d0e145 ">Char(10)</td>
|
||
|
|
<td valign="top" headers="d0e147 ">Acknowledgement target type</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e143 d0e150 ">74</td>
|
||
|
|
<td valign="top" headers="d0e143 d0e152 ">4A</td>
|
||
|
|
<td valign="top" headers="d0e145 ">Char(2)</td>
|
||
|
|
<td valign="top" headers="d0e147 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e143 d0e150 ">76</td>
|
||
|
|
<td valign="top" headers="d0e143 d0e152 ">4C</td>
|
||
|
|
<td valign="top" headers="d0e145 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e147 ">Default property</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e143 d0e150 ">80</td>
|
||
|
|
<td valign="top" headers="d0e143 d0e152 ">50</td>
|
||
|
|
<td valign="top" headers="d0e145 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e147 ">Number of threads</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e143 d0e150 ">84</td>
|
||
|
|
<td valign="top" headers="d0e143 d0e152 ">54</td>
|
||
|
|
<td valign="top" headers="d0e145 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e147 ">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).<div class="note"><span class="notetitle">Note:</span> Acknowledgment target description
|
||
|
|
names must be unique for each triggered cache manager server. They are referenced,
|
||
|
|
by name, from trigger handler descriptions associated with the same server.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Acknowledgement target type</strong></dt>
|
||
|
|
<dd>The type of acknowledgment target description that is added (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>*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>
|
||
|
|
</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>
|
||
|
|
</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>
|
||
|
|
</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>
|
||
|
|
</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 new description is associated (left justified and padded with blanks if
|
||
|
|
necessary).</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="d0e370">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e372">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e374">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e377">Dec</th>
|
||
|
|
<th valign="top" id="d0e379">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e370 d0e377 ">0</td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 ">0</td>
|
||
|
|
<td valign="top" headers="d0e372 ">Char(256)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">Everything from ATDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e370 d0e377 ">88</td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 ">58</td>
|
||
|
|
<td valign="top" headers="d0e372 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">HTTP IP interface</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e370 d0e377 ">344</td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 ">158</td>
|
||
|
|
<td valign="top" headers="d0e372 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">HTTP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e370 d0e377 ">348</td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 ">15C</td>
|
||
|
|
<td valign="top" headers="d0e372 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">Offset to HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e370 d0e377 ">352</td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 ">160</td>
|
||
|
|
<td valign="top" headers="d0e372 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">Length of HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e370 d0e377 ">356</td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 ">164</td>
|
||
|
|
<td valign="top" headers="d0e372 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">HTTP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e370 d0e377 ">360</td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 ">168</td>
|
||
|
|
<td valign="top" headers="d0e372 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">Timeout</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e370 d0e377 "> </td>
|
||
|
|
<td valign="top" headers="d0e370 d0e379 "> </td>
|
||
|
|
<td valign="top" headers="d0e372 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e374 ">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><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>
|
||
|
|
</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 data transfer.</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 data transfer.</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>
|
||
|
|
</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>
|
||
|
|
</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 / .<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),
|
||
|
|
or -1 (QZHT_DEFAULT). 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), or -1 (QZHT_DEFAULT), 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>
|
||
|
|
</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>
|
||
|
|
</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="d0e616">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e618">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e620">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e623">Dec</th>
|
||
|
|
<th valign="top" id="d0e625">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e616 d0e623 ">0</td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 ">0</td>
|
||
|
|
<td valign="top" headers="d0e618 "> </td>
|
||
|
|
<td valign="top" headers="d0e620 ">Everything from ATDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e616 d0e623 ">88</td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 ">58</td>
|
||
|
|
<td valign="top" headers="d0e618 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e620 ">HTTP host</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e616 d0e623 ">120</td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 ">78</td>
|
||
|
|
<td valign="top" headers="d0e618 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e620 ">HTTP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e616 d0e623 ">124</td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 ">7C</td>
|
||
|
|
<td valign="top" headers="d0e618 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e620 ">Offset to HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e616 d0e623 ">128</td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 ">80</td>
|
||
|
|
<td valign="top" headers="d0e618 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e620 ">Length of HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e616 d0e623 ">132</td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 ">84</td>
|
||
|
|
<td valign="top" headers="d0e618 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e620 ">HTTP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e616 d0e623 ">136</td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 ">88</td>
|
||
|
|
<td valign="top" headers="d0e618 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e620 ">Timeout</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e616 d0e623 "> </td>
|
||
|
|
<td valign="top" headers="d0e616 d0e625 "> </td>
|
||
|
|
<td valign="top" headers="d0e618 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e620 ">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 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>
|
||
|
|
<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>
|
||
|
|
</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>
|
||
|
|
</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 / .<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),
|
||
|
|
or -1 (QZHT_DEFAULT). 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), or -1 (QZHT_DEFAULT), 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>
|
||
|
|
</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>
|
||
|
|
</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 &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 E</strong></dt>
|
||
|
|
<dd>User QTCM is not authorized to the configuration file for triggered cache
|
||
|
|
manager server &1.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
|
||
|
|
<dd>A configuration file for triggered cache manager server &1 was not
|
||
|
|
found.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7222 E</strong></dt>
|
||
|
|
<dd>A default &1 is not designated for triggered cache manager server &2.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM7293 E</strong></dt>
|
||
|
|
<dd>A &1 using the name &2 already exists for triggered cache manager
|
||
|
|
server &3.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM72C0 E</strong></dt>
|
||
|
|
<dd>Triggered cache manager &1 name is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM72C1 E</strong></dt>
|
||
|
|
<dd>Triggered cache manager &1 type is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM72C2 E</strong></dt>
|
||
|
|
<dd>Triggered cache manager description type &1 cannot be specified when
|
||
|
|
using data format &2.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM72C3 E</strong></dt>
|
||
|
|
<dd>Value passed to offset &1 is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>TCM74C0 E</strong></dt>
|
||
|
|
<dd>Triggered cache manager server name is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|