1289 lines
63 KiB
HTML
1289 lines
63 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 Cache Target Description (QzhtAddTCMCacheTargetDesc) 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_qzhtaddtcmcachetargetdesc" />
|
||
|
|
<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 Cache Target Description (QzhtAddTCMCacheTargetDesc)
|
||
|
|
API</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaieapi_qzhtaddtcmcachetargetdesc"><a name="rzaieapi_qzhtaddtcmcachetargetdesc"><!-- --></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 Cache Target Description (QzhtAddTCMCacheTargetDesc)
|
||
|
|
API</h1>
|
||
|
|
<div><div class="important"><span class="importanttitle">Important:</span> Information
|
||
|
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
||
|
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
||
|
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
||
|
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">request variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">length of request variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">request variable format</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">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 QzhtAddTCMCacheTargetDesc API to add new cache target descriptions
|
||
|
|
to the configurations of triggered cache manager servers. New cache target
|
||
|
|
descriptions are referenced subsequently, by name, from trigger handler descriptions
|
||
|
|
associated with the same server. New cache 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 cache target description. See Cache 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>CTDP0100: Basic information format for a cache target description.</li>
|
||
|
|
<li>CTDP0200: Detailed information format for an *IFS type cache target description.</li>
|
||
|
|
<li>CTDP0300: Detailed information format for a *HTTP1 type cache target description.</li>
|
||
|
|
<li>CTDP0310: Detailed information format for a *HTTP2 type cache target description.</li>
|
||
|
|
<li>CTDP0500: Detailed information format for a *ECCP1 type cache target description.</li>
|
||
|
|
<li>CTDP0510: Detailed information format for a *ECCP2 type cache 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="ctdp0100_format"><a name="ctdp0100_format"><!-- --></a><h2 class="topictitle2">CTDP0100 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="d0e149">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e151">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e153">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e156">Dec</th>
|
||
|
|
<th valign="top" id="d0e158">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e149 d0e156 ">0</td>
|
||
|
|
<td valign="top" headers="d0e149 d0e158 ">0</td>
|
||
|
|
<td valign="top" headers="d0e151 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e153 ">Server name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e149 d0e156 ">32</td>
|
||
|
|
<td valign="top" headers="d0e149 d0e158 ">20</td>
|
||
|
|
<td valign="top" headers="d0e151 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e153 ">Cache target description name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e149 d0e156 ">64</td>
|
||
|
|
<td valign="top" headers="d0e149 d0e158 ">40</td>
|
||
|
|
<td valign="top" headers="d0e151 ">Char(10)</td>
|
||
|
|
<td valign="top" headers="d0e153 ">Cache target type</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e149 d0e156 ">74</td>
|
||
|
|
<td valign="top" headers="d0e149 d0e158 ">4A</td>
|
||
|
|
<td valign="top" headers="d0e151 ">Char(2)</td>
|
||
|
|
<td valign="top" headers="d0e153 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e149 d0e156 ">76</td>
|
||
|
|
<td valign="top" headers="d0e149 d0e158 ">4C</td>
|
||
|
|
<td valign="top" headers="d0e151 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e153 ">Default property</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e149 d0e156 ">80</td>
|
||
|
|
<td valign="top" headers="d0e149 d0e158 ">50</td>
|
||
|
|
<td valign="top" headers="d0e151 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e153 ">Number of threads</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e149 d0e156 ">84</td>
|
||
|
|
<td valign="top" headers="d0e149 d0e158 ">54</td>
|
||
|
|
<td valign="top" headers="d0e151 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e153 ">Initial state</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0100_field_descriptions"><a name="ctdp0100_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0100 format field descriptions</h2>
|
||
|
|
<div><div class="note"><span class="notetitle">Note:</span> Cache target descriptions are added using default values for all unspecified
|
||
|
|
values according to the type specified by Cache target type). See other cache
|
||
|
|
target description formats for details regarding these default values. This
|
||
|
|
format cannot be used to add cache target descriptions of type *ECCP1 or *ECCP2.</div>
|
||
|
|
<dl><dt class="dlterm"><strong>Cache target description name</strong></dt>
|
||
|
|
<dd>The name used by the new cache target description (left justified and
|
||
|
|
padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> Cache 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>Cache target type</strong></dt>
|
||
|
|
<dd>The type of cache 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>*IFS</strong></dt>
|
||
|
|
<dd>QZHT_IFS_TYPE: An *IFS type is added.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>*HTTP1</strong></dt>
|
||
|
|
<dd>QZHT_HTTP_TYPE1: An *HTTP1 type is added.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>*HTTP2</strong></dt>
|
||
|
|
<dd>QZHT_HTTP_TYPE2: An *HTTP2 type is added.</dd>
|
||
|
|
</dl>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Cache target description types of *ECCP1 and *ECCP2 must
|
||
|
|
be added using the CTDP0500 and CTDP0510 formats, respectively.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Default property</strong></dt>
|
||
|
|
<dd>Specifies if the new description will become the 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). <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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description becomes
|
||
|
|
the default cache target description for this server.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
|
||
|
|
is not the default cache target description.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Multiple default cache target descriptions are allowed. Trigger
|
||
|
|
handler descriptions added or changed using the *DEFAULT special value reference
|
||
|
|
all cache 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 cache 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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
|
||
|
|
is enabled at server startup.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request processor
|
||
|
|
is disabled at server startup.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> The state of a cache target request processor can be changed
|
||
|
|
while the triggered cache manager server is active by using the -<em>chsink</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 cache 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.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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="ctdp0200_format"><a name="ctdp0200_format"><!-- --></a><h2 class="topictitle2">CTDP0200 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="d0e385">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e387">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e389">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e392">Dec</th>
|
||
|
|
<th valign="top" id="d0e394">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e385 d0e392 ">0</td>
|
||
|
|
<td valign="top" headers="d0e385 d0e394 ">0</td>
|
||
|
|
<td valign="top" headers="d0e387 "> </td>
|
||
|
|
<td valign="top" headers="d0e389 ">Everything from CTDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e385 d0e392 ">88</td>
|
||
|
|
<td valign="top" headers="d0e385 d0e394 ">58</td>
|
||
|
|
<td valign="top" headers="d0e387 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e389 ">Offset to local directory root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e385 d0e392 ">92</td>
|
||
|
|
<td valign="top" headers="d0e385 d0e394 ">5C</td>
|
||
|
|
<td valign="top" headers="d0e387 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e389 ">Length of local directory root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e385 d0e392 "> </td>
|
||
|
|
<td valign="top" headers="d0e385 d0e394 "> </td>
|
||
|
|
<td valign="top" headers="d0e387 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e389 ">Local directory root</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0200_field_descriptions"><a name="ctdp0200_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0200 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.<div class="note"><span class="notetitle">Note:</span> If
|
||
|
|
Offset to local directory root equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT),
|
||
|
|
this value must equal 0.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Local directory root</strong></dt>
|
||
|
|
<dd>The path to the local file system directory that is the root of this cache
|
||
|
|
target (left justified and padded with blanks if necessary). The value must
|
||
|
|
be a path acceptable to the root (/) file system of the local iSeries™ system.
|
||
|
|
If a path is provided, but does not specify a absolute path (does not start
|
||
|
|
with / ), the path is prepended with the default path. The default path is
|
||
|
|
/QIBM/UserData/TCM/{Server name} where {Server name} is the name of the triggered
|
||
|
|
cache manager server as defined by Server name.<div class="note"><span class="notetitle">Note:</span> All requests for files
|
||
|
|
from the cache target must have this path prepended to the file name, even
|
||
|
|
if an absolute file path is specified. If the value is null, Offset to local
|
||
|
|
directory root must equal 0 (QZHT_NONE) or -1 (QZHT_DEFAULT). See Offset to
|
||
|
|
local directory root for more details.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Offset to local directory root</strong></dt>
|
||
|
|
<dd>The offset from the beginning of the request variable to the Local directory
|
||
|
|
root data, in bytes. The value must be greater that 0, 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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default path is used for Local directory
|
||
|
|
root.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0300_format"><a name="ctdp0300_format"><!-- --></a><h2 class="topictitle2">CTDP0300 format</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top">Offset</td>
|
||
|
|
<td valign="top"> </td>
|
||
|
|
<td valign="top">Type</td>
|
||
|
|
<td valign="top">Field</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">Dec</td>
|
||
|
|
<td valign="top">Hex</td>
|
||
|
|
<td valign="top"> </td>
|
||
|
|
<td valign="top"> </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">0</td>
|
||
|
|
<td valign="top">0</td>
|
||
|
|
<td valign="top">Char(256)</td>
|
||
|
|
<td valign="top">Everything from CTDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">88</td>
|
||
|
|
<td valign="top">58</td>
|
||
|
|
<td valign="top">Binary(4)</td>
|
||
|
|
<td valign="top">HTTP IP interface</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">344</td>
|
||
|
|
<td valign="top">158</td>
|
||
|
|
<td valign="top">Binary(4)</td>
|
||
|
|
<td valign="top">HTTP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">348</td>
|
||
|
|
<td valign="top">15C</td>
|
||
|
|
<td valign="top">Binary(4)</td>
|
||
|
|
<td valign="top">Offset to HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">352</td>
|
||
|
|
<td valign="top">160</td>
|
||
|
|
<td valign="top">Binary(4)</td>
|
||
|
|
<td valign="top">Length of HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">356</td>
|
||
|
|
<td valign="top">164</td>
|
||
|
|
<td valign="top">Binary(4)</td>
|
||
|
|
<td valign="top">HTTP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top">360</td>
|
||
|
|
<td valign="top">168</td>
|
||
|
|
<td valign="top">Binary(4)</td>
|
||
|
|
<td valign="top">Timeout</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top"> </td>
|
||
|
|
<td valign="top"> </td>
|
||
|
|
<td valign="top">Char(*)</td>
|
||
|
|
<td valign="top">HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0300_field_description"><a name="ctdp0300_field_description"><!-- --></a><h2 class="topictitle2">CTDP0300 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 (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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
|
||
|
|
kept open after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
|
||
|
|
closed after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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 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). The value must be a path acceptable
|
||
|
|
to HTTP Server. The default path is / .<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 path for
|
||
|
|
the file is specified. 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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0310_format"><a name="ctdp0310_format"><!-- --></a><h2 class="topictitle2">CTDP0310 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="d0e741">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e743">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e745">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e748">Dec</th>
|
||
|
|
<th valign="top" id="d0e750">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e741 d0e748 ">0</td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 ">0</td>
|
||
|
|
<td valign="top" headers="d0e743 "> </td>
|
||
|
|
<td valign="top" headers="d0e745 ">Everything from CTDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e741 d0e748 ">88</td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 ">58</td>
|
||
|
|
<td valign="top" headers="d0e743 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e745 ">HTTP host</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e741 d0e748 ">120</td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 ">78</td>
|
||
|
|
<td valign="top" headers="d0e743 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e745 ">HTTP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e741 d0e748 ">124</td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 ">7C</td>
|
||
|
|
<td valign="top" headers="d0e743 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e745 ">Offset to HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e741 d0e748 ">128</td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 ">80</td>
|
||
|
|
<td valign="top" headers="d0e743 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e745 ">Length of HTTP URI</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e741 d0e748 ">132</td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 ">84</td>
|
||
|
|
<td valign="top" headers="d0e743 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e745 ">HTTP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e741 d0e748 ">136</td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 ">88</td>
|
||
|
|
<td valign="top" headers="d0e743 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e745 ">Timeout</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e741 d0e748 "> </td>
|
||
|
|
<td valign="top" headers="d0e741 d0e750 "> </td>
|
||
|
|
<td valign="top" headers="d0e743 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e745 ">HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0310_field_description"><a name="ctdp0310_field_description"><!-- --></a><h2 class="topictitle2">CTDP0310 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, 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
|
||
|
|
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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
|
||
|
|
kept open after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
|
||
|
|
closed after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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 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). 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 files to
|
||
|
|
this cache target have this path inserted into the URI, even if an absolute
|
||
|
|
file path is specified. 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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0500_format"><a name="ctdp0500_format"><!-- --></a><h2 class="topictitle2">CTDP0500 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="d0e988">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e990">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e992">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e995">Dec</th>
|
||
|
|
<th valign="top" id="d0e997">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e988 d0e995 ">0</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">0</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Server name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">32</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">20</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Cache target description name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">64</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">40</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Char(10)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Cache target type</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">74</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">4A</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Char(2)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">76</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">4C</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Default property</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">80</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">50</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Number of threads</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">84</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">54</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Initial state</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">88</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">58</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Char(256)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">ECCP IP interface</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">344</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">158</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">ECCP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">348</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">15C</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">HTTP cluster IP interface</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">604</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">260</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">HTTP cluster TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">608</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">264</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Offset to HTTP cluster URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">612</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">268</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">Length of HTTP cluster URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 ">6161</td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 ">26C</td>
|
||
|
|
<td valign="top" headers="d0e990 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">ECCP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e988 d0e995 "> </td>
|
||
|
|
<td valign="top" headers="d0e988 d0e997 "> </td>
|
||
|
|
<td valign="top" headers="d0e990 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e992 ">HTTP cluster URI root</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0500_field_descriptions"><a name="ctdp0500_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0500 format field descriptions</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>Cache target description name</strong></dt>
|
||
|
|
<dd>The name used by the new cache target description (left justified and
|
||
|
|
padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> Cache 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>Cache target type</strong></dt>
|
||
|
|
<dd>The added cache target descriptions type (left justified and padded with
|
||
|
|
blanks if necessary). The value must be one of the special values described
|
||
|
|
below. <p>Special values and their meanings are as follows:</p>
|
||
|
|
<dl><dt class="dlterm"><strong>*ECCP1</strong></dt>
|
||
|
|
<dd>QZHT_ECCP_TYPE1: An *ECCP1 type is added.</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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
|
||
|
|
is not a default cache target description.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is specified.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Multiple default cache target descriptions are allowed. Trigger
|
||
|
|
handler descriptions added or changed, using the *DEFAULT special value, reference
|
||
|
|
all cache target descriptions designated as default at the time they are added
|
||
|
|
or changed.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<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 (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). 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.
|
||
|
|
There is no default value for this entry.<div class="note"><span class="notetitle">Note:</span> An exception occurs if an IP
|
||
|
|
host name or address is not specified. 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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
|
||
|
|
kept open after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
|
||
|
|
closed after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> The network router must support keepalive for this option to
|
||
|
|
function properly.</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. There is no
|
||
|
|
default value for this entry.<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), 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. There is no default value for this
|
||
|
|
entry.<div class="note"><span class="notetitle">Note:</span> An IP host name or address must be specified. See HTTP cluster
|
||
|
|
TCP port for more information.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTTP cluster TCP port</strong></dt>
|
||
|
|
<dd>The web server cluster URI path that is used to define the root for this
|
||
|
|
cache target (left justified and padded with blanks if necessary). The value
|
||
|
|
must be a path acceptable to the web server cluster (from which the network
|
||
|
|
router is hosting a cache). The default path is /.<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. If the value is null, Offset to HTTP cluster
|
||
|
|
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>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). The value
|
||
|
|
must be a path acceptable to the web server cluster from which the network
|
||
|
|
router is hosting a cache. The default path is /.<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. If the value is null, Offset to HTTP cluster 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>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. 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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
|
||
|
|
is enabled at server startup.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request processor
|
||
|
|
is disabled at server startup.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> The state of a cache target request processor can be changed
|
||
|
|
while the triggered cache manager server is active by using the -<em>chsink</em> command
|
||
|
|
in a trigger message.</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.<div class="note"><span class="notetitle">Note:</span> If
|
||
|
|
Offset to HTTP cluster URI root equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT),
|
||
|
|
this value must equal 0.</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>), 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.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</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 cluster
|
||
|
|
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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default path is used for HTTP cluster
|
||
|
|
URI root.</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="ctdp0510_format"><a name="ctdp0510_format"><!-- --></a><h2 class="topictitle2">CTDP0510 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="d0e1386">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e1388">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e1390">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e1393">Dec</th>
|
||
|
|
<th valign="top" id="d0e1395">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e1386 d0e1393 ">0</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">0</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Server name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">32</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">20</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Cache target description name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">64</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">40</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Char(10)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Cache target type</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">74</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">4A</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Char(2)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">76</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">4C</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Default property</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">80</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">50</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Number of threads</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">84</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">54</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Initial state</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">88</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">58</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">ECCP host</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">120</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">78</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">ECCP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">124</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">7C</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Char(256)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">HTTP cluster IP interface</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">380</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">17C</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">HTTP cluster TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">384</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">180</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Offset to HTTP cluster URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">388</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">184</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">Length of HTTP cluster URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 ">392</td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 ">188</td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">ECCP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1386 d0e1393 "> </td>
|
||
|
|
<td valign="top" headers="d0e1386 d0e1395 "> </td>
|
||
|
|
<td valign="top" headers="d0e1388 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e1390 ">HTTP cluster URI root</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="ctdp0510_field_descriptions"><a name="ctdp0510_field_descriptions"><!-- --></a><h2 class="topictitle2">CTDP0510 format field descriptions</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>Cache target description name</strong></dt>
|
||
|
|
<dd>The name used by the new cache target description (left justified and
|
||
|
|
padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> Cache 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>Cache target type</strong></dt>
|
||
|
|
<dd>The added cache target description type (left justified and padded with
|
||
|
|
blanks if necessary). The value must be one of the special values described
|
||
|
|
below. <p>Special values and their meanings are as follows:</p>
|
||
|
|
<dl><dt class="dlterm">*ECCP1</dt>
|
||
|
|
<dd>QZHT_ECCP_TYPE2: An *ECCP2 type is added.</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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
|
||
|
|
is not a default cache target description.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is specified.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Multiple default cache target descriptions are allowed. Trigger
|
||
|
|
handler descriptions added or changed, using the *DEFAULT special value, reference
|
||
|
|
all cache target descriptions designated as default at the time they are added
|
||
|
|
or changed.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<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, or one of
|
||
|
|
the special values described below (left justified and padded with blanks
|
||
|
|
if necessary). The default setting references 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 is referenced.<div class="note"><span class="notetitle">Note:</span> See ECCP 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>
|
||
|
|
</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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
|
||
|
|
kept open after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
|
||
|
|
closed after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> The network router must support keepalive for this option to
|
||
|
|
function properly.</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> There
|
||
|
|
is no default value for this entry. A TCP port number must be specified. 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), 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. There is no default value for this
|
||
|
|
entry.<div class="note"><span class="notetitle">Note:</span> There is no default value for this entry. An IP host name or address
|
||
|
|
must be specified. 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 associated with the IP host name or address
|
||
|
|
described by HTTP cluster IP interface. The value must be greater than 0 and
|
||
|
|
less than 65536.<div class="note"><span class="notetitle">Note:</span> There is no default value for this entry. A TCP port
|
||
|
|
number must be specified. 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). The value
|
||
|
|
must be a path acceptable to the web server cluster from which the network
|
||
|
|
router is hosting a cache. The default path is /.<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. If the value is null, Offset to HTTP cluster 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>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. 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.151515151515152%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The request processor
|
||
|
|
is enabled at server startup.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The request processor
|
||
|
|
is disabled at server startup.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> The state of a cache target request processor can be changed
|
||
|
|
while the triggered cache manager server is active by using the -<em>chsink</em> command
|
||
|
|
in a trigger message.</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.<div class="note"><span class="notetitle">Note:</span> <strong></strong></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>), 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.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</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 cluster
|
||
|
|
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.151515151515152%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.151515151515152%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.84848484848484%">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="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>
|