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_qzhtrtvtcmcachetargetdesc.htm

876 lines
42 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="Retrieve Triggered Cache Manager Cache Target Description (QzhtRtvTCMCacheTargetDesc) 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_qzhtrtvtcmcachetargetdesc" />
<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 Cache Target Description (QzhtRtvTCMCacheTargetDesc)
API</title>
</head>
<body id="rzaieapi_qzhtrtvtcmcachetargetdesc"><a name="rzaieapi_qzhtrtvtcmcachetargetdesc"><!-- --></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 Cache Target Description (QzhtRtvTCMCacheTargetDesc)
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 QzhtRtvTCMCacheTargetDesc API to retrieve information from cache
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 cache target description
information. See Cache 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>CTDG0100: Basic information format for a cache target description.</li>
<li>CTDG0200: Detailed information format for an *IFS type cache target description.</li>
<li>CTDG0300: Detailed information format for an *HTTP1 type cache target
description.</li>
<li>CTDG0310: Detailed information format for an *HTTP2 type cache target
description.</li>
<li>CTDG0500: Detailed information format for an *ECCP1 type cache target
description.</li>
<li>CTDG0510: Detailed information format for an *ECCP2 type cache target
description.</li>
</ul>
<div class="note"><span class="notetitle">Note:</span> See Cache target description formats for more information.</div>
</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 the configuration information is retrieved (left justified
and padded with blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>description name</strong></dt>
<dd>CHAR(32) <p>The name used to identify which cache target description information
is retrieved (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="ctdg0100_format"><a name="ctdg0100_format"><!-- --></a><h2 class="topictitle2">CTDG0100 format</h2>
<div><div class="note"><span class="notetitle">Note:</span> When the cache target description type is unknown, use the CTDG0100
format and the basic information (including cache target type) is returned.
You may then use the returned cache target type to call the API and return
detailed information about the cache target description (using one of the
detailed information formats).</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="d0e189">Offset</th>
<th rowspan="2" valign="top" id="d0e191">Type</th>
<th rowspan="2" valign="top" id="d0e193">Field</th>
</tr>
<tr><th valign="top" id="d0e196">Dec</th>
<th valign="top" id="d0e198">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e189 d0e196 ">0</td>
<td valign="top" headers="d0e189 d0e198 ">0</td>
<td valign="top" headers="d0e191 ">Binary(4)</td>
<td valign="top" headers="d0e193 ">Bytes returned</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">4</td>
<td valign="top" headers="d0e189 d0e198 ">4</td>
<td valign="top" headers="d0e191 ">Binary(4)</td>
<td valign="top" headers="d0e193 ">Bytes available</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">8</td>
<td valign="top" headers="d0e189 d0e198 ">8</td>
<td valign="top" headers="d0e191 ">Char(32)</td>
<td valign="top" headers="d0e193 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">40</td>
<td valign="top" headers="d0e189 d0e198 ">28</td>
<td valign="top" headers="d0e191 ">Char(32)</td>
<td valign="top" headers="d0e193 ">Cache target description name</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">72</td>
<td valign="top" headers="d0e189 d0e198 ">48</td>
<td valign="top" headers="d0e191 ">Char(10)</td>
<td valign="top" headers="d0e193 ">Cache target type</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">82</td>
<td valign="top" headers="d0e189 d0e198 ">52</td>
<td valign="top" headers="d0e191 ">Char(2)</td>
<td valign="top" headers="d0e193 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">84</td>
<td valign="top" headers="d0e189 d0e198 ">54</td>
<td valign="top" headers="d0e191 ">Binary(4)</td>
<td valign="top" headers="d0e193 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">88</td>
<td valign="top" headers="d0e189 d0e198 ">58</td>
<td valign="top" headers="d0e191 ">Binary(4)</td>
<td valign="top" headers="d0e193 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e189 d0e196 ">92</td>
<td valign="top" headers="d0e189 d0e198 ">5C</td>
<td valign="top" headers="d0e191 ">Binary(4)</td>
<td valign="top" headers="d0e193 ">Initial state</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdg0100_field_descriptions"><a name="ctdg0100_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDG0100 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>Cache target description name</strong></dt>
<dd>The cache target description name (left justified and padded with blanks
if necessary).</dd>
</dl>
<dl><dt class="dlterm"><strong>Cache target type</strong></dt>
<dd>The cache target description type (left justified and padded with blanks
if necessary). The returned value equals one of the special values below. <p>Special
values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*IFS</strong></dt>
<dd>QZHT_IFS_TYPE</dd>
</dl>
<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>
<dl><dt class="dlterm"><strong>*ECCP1</strong></dt>
<dd>QZHT_ECCP_TYPE1</dd>
</dl>
<dl><dt class="dlterm"><strong>*ECCP2</strong></dt>
<dd>QZHT_ECCP_TYPE2</dd>
</dl>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Specifies if the new description is a default cache 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).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.979381443298967%"><strong>1</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
a default cache target description for this server.</td>
</tr>
<tr><td valign="top" width="15.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
is not a default cache target description.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> Multiple default cache target descriptions are possible.</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 cache target, is in at server startup. The value must equal one of
the special values described below.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.979381443298967%"><strong>1</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
is enabled at server startup.</td>
</tr>
<tr><td valign="top" width="15.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request 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 processing requests sent to this cache target. The value must be greater
that 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 from which the configuration
information is retrieved (left justified and padded with blanks if necessary).</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdg0200_format"><a name="ctdg0200_format"><!-- --></a><h2 class="topictitle2">CTDG0200 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="d0e435">Offset</th>
<th rowspan="2" valign="top" id="d0e437">Type</th>
<th rowspan="2" valign="top" id="d0e439">Field</th>
</tr>
<tr><th valign="top" id="d0e442">Dec</th>
<th valign="top" id="d0e444">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e435 d0e442 ">0</td>
<td valign="top" headers="d0e435 d0e444 ">0</td>
<td valign="top" headers="d0e437 ">&nbsp;</td>
<td valign="top" headers="d0e439 ">Everything from CTDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e435 d0e442 ">96</td>
<td valign="top" headers="d0e435 d0e444 ">60</td>
<td valign="top" headers="d0e437 ">Binary(4)</td>
<td valign="top" headers="d0e439 ">Offset to local directory root</td>
</tr>
<tr><td valign="top" headers="d0e435 d0e442 ">100</td>
<td valign="top" headers="d0e435 d0e444 ">64</td>
<td valign="top" headers="d0e437 ">Binary(4)</td>
<td valign="top" headers="d0e439 ">Length of local directory root</td>
</tr>
<tr><td valign="top" headers="d0e435 d0e442 ">&nbsp;</td>
<td valign="top" headers="d0e435 d0e444 ">&nbsp;</td>
<td valign="top" headers="d0e437 ">Char(*)</td>
<td valign="top" headers="d0e439 ">Local directory root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdg0200_field_descriptions"><a name="ctdg0200_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDG0200 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Length of local directory root</strong></dt>
<dd>The length of the information for the Local directory root entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Local directory root</strong></dt>
<dd>The path to the local file system directory that defines the root for
this cache target (left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All
file requests send to the cache target have this path prepended to the file
name, even if an absolute file path is specified.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to local directory root</strong></dt>
<dd>The offset from the beginning of the receiver variable to the Local directory
root data, in bytes.</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdg0300_format"><a name="ctdg0300_format"><!-- --></a><h2 class="topictitle2">CTDG0300 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="d0e519">Offset</th>
<th rowspan="2" valign="top" id="d0e521">Type</th>
<th rowspan="2" valign="top" id="d0e523">Field</th>
</tr>
<tr><th valign="top" id="d0e526">Dec</th>
<th valign="top" id="d0e528">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e519 d0e526 ">0</td>
<td valign="top" headers="d0e519 d0e528 ">0</td>
<td valign="top" headers="d0e521 ">&nbsp;</td>
<td valign="top" headers="d0e523 ">Everything from CTDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e519 d0e526 ">96</td>
<td valign="top" headers="d0e519 d0e528 ">60</td>
<td valign="top" headers="d0e521 ">Char(256)</td>
<td valign="top" headers="d0e523 ">HTTP IP interface</td>
</tr>
<tr><td valign="top" headers="d0e519 d0e526 ">352</td>
<td valign="top" headers="d0e519 d0e528 ">160</td>
<td valign="top" headers="d0e521 ">Binary(4)</td>
<td valign="top" headers="d0e523 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e519 d0e526 ">356</td>
<td valign="top" headers="d0e519 d0e528 ">164</td>
<td valign="top" headers="d0e521 ">Binary(4)</td>
<td valign="top" headers="d0e523 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e519 d0e526 ">360</td>
<td valign="top" headers="d0e519 d0e528 ">168</td>
<td valign="top" headers="d0e521 ">Binary(4)</td>
<td valign="top" headers="d0e523 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e519 d0e526 ">364</td>
<td valign="top" headers="d0e519 d0e528 ">16C</td>
<td valign="top" headers="d0e521 ">Binary(4)</td>
<td valign="top" headers="d0e523 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e519 d0e526 ">368</td>
<td valign="top" headers="d0e519 d0e528 ">170</td>
<td valign="top" headers="d0e521 ">Binary(4)</td>
<td valign="top" headers="d0e523 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e519 d0e526 ">&nbsp;</td>
<td valign="top" headers="d0e519 d0e528 ">&nbsp;</td>
<td valign="top" headers="d0e521 ">Char(*)</td>
<td valign="top" headers="d0e523 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdg0300_field_descriptions"><a name="ctdg0300_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDG0300 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 cache
target. The value must be a host name (for example, server.mycompany.com),
dotted address (for example, 192.168.3.57) (left justified and padded with
blanks if necessary).<div class="note"><span class="notetitle">Note:</span> See HTTP TCP port for more information.</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.979381443298967%"><strong>1</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">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 the IP host name or address in HTTP IP interface
to establish communication with HTTP Server cache 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 cache target (left
justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All file requests from
this cache target have this path inserted into the URI, even if an absolute
file path is specified.</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.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">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="ctdg0310_format"><a name="ctdg0310_format"><!-- --></a><h2 class="topictitle2">CTDG0310 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="d0e709">Offset</th>
<th rowspan="2" valign="top" id="d0e711">Type</th>
<th rowspan="2" valign="top" id="d0e713">Field</th>
</tr>
<tr><th valign="top" id="d0e716">Dec</th>
<th valign="top" id="d0e718">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e709 d0e716 ">0</td>
<td valign="top" headers="d0e709 d0e718 ">0</td>
<td valign="top" headers="d0e711 ">&nbsp;</td>
<td valign="top" headers="d0e713 ">Everything from CTDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e709 d0e716 ">96</td>
<td valign="top" headers="d0e709 d0e718 ">60</td>
<td valign="top" headers="d0e711 ">Char(32)</td>
<td valign="top" headers="d0e713 ">HTTP host</td>
</tr>
<tr><td valign="top" headers="d0e709 d0e716 ">128</td>
<td valign="top" headers="d0e709 d0e718 ">80</td>
<td valign="top" headers="d0e711 ">Binary(4)</td>
<td valign="top" headers="d0e713 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e709 d0e716 ">132</td>
<td valign="top" headers="d0e709 d0e718 ">84</td>
<td valign="top" headers="d0e711 ">Binary(4)</td>
<td valign="top" headers="d0e713 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e709 d0e716 ">136</td>
<td valign="top" headers="d0e709 d0e718 ">88</td>
<td valign="top" headers="d0e711 ">Binary(4)</td>
<td valign="top" headers="d0e713 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e709 d0e716 ">140</td>
<td valign="top" headers="d0e709 d0e718 ">8C</td>
<td valign="top" headers="d0e711 ">Binary(4)</td>
<td valign="top" headers="d0e713 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e709 d0e716 ">144</td>
<td valign="top" headers="d0e709 d0e718 ">90</td>
<td valign="top" headers="d0e711 ">Binary(4)</td>
<td valign="top" headers="d0e713 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e709 d0e716 ">&nbsp;</td>
<td valign="top" headers="d0e709 d0e718 ">&nbsp;</td>
<td valign="top" headers="d0e711 ">Char(*)</td>
<td valign="top" headers="d0e713 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdg0310_field_descriptions"><a name="ctdg0310_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDG0310 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 cache target description and used later,
at server startup, to obtain information about the system hosting an HTTP
server cache target. 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 cache 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 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.979381443298967%"><strong>1</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">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 the IP host name or address in HTTP host to establish
communication with HTTP Server cache 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 cache target
(left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All file requests
from this cache target have this path inserted into the URI, even if an absolute
file path is specified.</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.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">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="ctdg0500_format"><a name="ctdg0500_format"><!-- --></a><h2 class="topictitle2">CTFG0500 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="d0e899">Offset</th>
<th rowspan="2" valign="top" id="d0e901">Type</th>
<th rowspan="2" valign="top" id="d0e903">Field</th>
</tr>
<tr><th valign="top" id="d0e906">Dec</th>
<th valign="top" id="d0e908">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e899 d0e906 ">0</td>
<td valign="top" headers="d0e899 d0e908 ">0</td>
<td valign="top" headers="d0e901 ">&nbsp;</td>
<td valign="top" headers="d0e903 ">Everything from CTDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">96</td>
<td valign="top" headers="d0e899 d0e908 ">60</td>
<td valign="top" headers="d0e901 ">Char(32)</td>
<td valign="top" headers="d0e903 ">ECCP IP interface</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">352</td>
<td valign="top" headers="d0e899 d0e908 ">160</td>
<td valign="top" headers="d0e901 ">Char(10)</td>
<td valign="top" headers="d0e903 ">ECCP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">356</td>
<td valign="top" headers="d0e899 d0e908 ">164</td>
<td valign="top" headers="d0e901 ">Char(2)</td>
<td valign="top" headers="d0e903 ">HTTP cluster IP interface</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">612</td>
<td valign="top" headers="d0e899 d0e908 ">264</td>
<td valign="top" headers="d0e901 ">Binary(4)</td>
<td valign="top" headers="d0e903 ">HTTP cluster TCP port</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">616</td>
<td valign="top" headers="d0e899 d0e908 ">268</td>
<td valign="top" headers="d0e901 ">Binary(4)</td>
<td valign="top" headers="d0e903 ">Offset to HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">620</td>
<td valign="top" headers="d0e899 d0e908 ">26C</td>
<td valign="top" headers="d0e901 ">Binary(4)</td>
<td valign="top" headers="d0e903 ">Length of HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">624</td>
<td valign="top" headers="d0e899 d0e908 ">270</td>
<td valign="top" headers="d0e901 ">Char(256)</td>
<td valign="top" headers="d0e903 ">ECCP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e899 d0e906 ">&nbsp;</td>
<td valign="top" headers="d0e899 d0e908 ">&nbsp;</td>
<td valign="top" headers="d0e901 ">Char(*)</td>
<td valign="top" headers="d0e903 ">HTTP cluster URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdg0500_field_descriptions"><a name="ctdg0500_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDG0500 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>ECCP IP interface</strong></dt>
<dd>The IP host name or address of the backend IP interface to the network
router hosting a web server cluster cache target. The value must be a host
name (for example, server.mycompany.com) or dotted address (for example, 192.168.3.57)
(left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> See ECCP TCP port
for more information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP keepalive</strong></dt>
<dd>Specifies if the connection to the network router is 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).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.979381443298967%"><strong>1</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">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>ECCP TCP port</strong></dt>
<dd>The TCP port number upon which the network router 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 the IP host name or address, in ECCP
IP interface, to establish communications with the network router cache target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster IP interface</strong></dt>
<dd>The IP host name or address of the web server cluster from which the network
router is hosting a cache (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).<div class="note"><span class="notetitle">Note:</span> See HTTP cluster TCP port for more
information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster TCP port</strong></dt>
<dd>The number of the TCP port used by the triggered cache manager server
to identify a particular web server cluster cache. The value returned must
be greater than 0 and less than 65536.<div class="note"><span class="notetitle">Note:</span> The network router described by
ECCP IP interface may host multiple web server caches. The TCP port number
returned here is used in combination with the IP address returned in HTTP
cluster IP interface to identify a particular web server cache when communicating
with the network router.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster URI root</strong></dt>
<dd>The web server cluster URI path that defines the root of this cache target
(left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All file requests
sent to this cache target have this path inserted into the URI, even if an
absolute file path is specified.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP cluster URI root</strong></dt>
<dd>The length of the information for the HTTP cluster URI root entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP cluster URI root</strong></dt>
<dd>The offset from the beginning of the receiver variable to the HTTP cluster
URI root data, in bytes.</dd>
</dl>
</div>
</div>
<div class="nested1" id="ctdg0510_format"><a name="ctdg0510_format"><!-- --></a><h2 class="topictitle2">CTDG0510 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="d0e1088">Offset</th>
<th rowspan="2" valign="top" id="d0e1090">Type</th>
<th rowspan="2" valign="top" id="d0e1092">Field</th>
</tr>
<tr><th valign="top" id="d0e1095">Dec</th>
<th valign="top" id="d0e1097">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e1088 d0e1095 ">0</td>
<td valign="top" headers="d0e1088 d0e1097 ">0</td>
<td valign="top" headers="d0e1090 ">&nbsp;</td>
<td valign="top" headers="d0e1092 ">Everything from CTDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">96</td>
<td valign="top" headers="d0e1088 d0e1097 ">60</td>
<td valign="top" headers="d0e1090 ">Char(32)</td>
<td valign="top" headers="d0e1092 ">ECCP host</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">128</td>
<td valign="top" headers="d0e1088 d0e1097 ">80</td>
<td valign="top" headers="d0e1090 ">Binary(4)</td>
<td valign="top" headers="d0e1092 ">ECCP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">132</td>
<td valign="top" headers="d0e1088 d0e1097 ">84</td>
<td valign="top" headers="d0e1090 ">Char(256)</td>
<td valign="top" headers="d0e1092 ">HTTP cluster IP interface</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">388</td>
<td valign="top" headers="d0e1088 d0e1097 ">184</td>
<td valign="top" headers="d0e1090 ">Binary(4)</td>
<td valign="top" headers="d0e1092 ">HTTP cluster TCP port</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">392</td>
<td valign="top" headers="d0e1088 d0e1097 ">188</td>
<td valign="top" headers="d0e1090 ">Binary(4)</td>
<td valign="top" headers="d0e1092 ">Offset to HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">396</td>
<td valign="top" headers="d0e1088 d0e1097 ">18C</td>
<td valign="top" headers="d0e1090 ">Binary(4)</td>
<td valign="top" headers="d0e1092 ">Length of HTTP cluster URI root</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">400</td>
<td valign="top" headers="d0e1088 d0e1097 ">190</td>
<td valign="top" headers="d0e1090 ">Binary(4)</td>
<td valign="top" headers="d0e1092 ">ECCP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e1088 d0e1095 ">&nbsp;</td>
<td valign="top" headers="d0e1088 d0e1097 ">&nbsp;</td>
<td valign="top" headers="d0e1090 ">Char(*)</td>
<td valign="top" headers="d0e1092 ">HTTP cluster URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="ctdg0510_field_descriptions"><a name="ctdg0510_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDG0510 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>ECCP host</strong></dt>
<dd>The name of a host description associated with the triggered cache manager
server referenced by the new cache target description and used later, at server
startup, to obtain information about the network router hosting a web server
cluster cache target. 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 ECCP 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 cache target description was last modified.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>ECCP keepalive</strong></dt>
<dd>Specifies if the connection to the network router is 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).
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.979381443298967%"><strong>1</strong></td>
<td valign="top" width="84.02061855670104%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
kept open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.979381443298967%"><strong>0</strong></td>
<td valign="top" width="84.02061855670104%">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>ECCP TCP port</strong></dt>
<dd>The TCP port number upon which the network router 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 the IP host name or address, obtained
at server startup, from the host description (specified in ECCP host) to establish
communication with the network router cache target.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster IP interface</strong></dt>
<dd>The IP host name or address of the web server cluster from which the network
router is hosting a cache (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).<div class="note"><span class="notetitle">Note:</span> See HTTP cluster TCP port for more
information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster TCP port</strong></dt>
<dd>The TCP port number used by the triggered cache manager server to identify
a particular web server cluster cache. The value must be greater than 0 and
less than 65536.<div class="note"><span class="notetitle">Note:</span> The network router using the address, described by ECCP
host, may host multiple web server caches. The TCP port number specified here
is used in combination with the IP host name or address in HTTP cluster IP
interface to identify a particular web server cache when communicating with
the network router.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP cluster URI root</strong></dt>
<dd>The web server cluster URI path that is used to define the root of this
cache target (left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All
file requests sent to this cache target have this path inserted into the URI,
even if an absolute file path is specified.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP cluster URI root</strong></dt>
<dd>The length of the information for the HTTP cluster URI root entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP cluster URI root</strong></dt>
<dd>The offset from the beginning of the receiver variable to the HTTP cluster
URI root data, in bytes.</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