951 lines
46 KiB
HTML
951 lines
46 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="Change Triggered Cache Manager Data Source Description (QzhtChgTCMDataSourceDesc) 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_qzhtchgtcmdatasourcedesc" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>Change Triggered Cache Manager Data Source Description (QzhtChgTCMDataSourceDesc)
|
||
|
|
API</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaieapi_qzhtchgtcmdatasourcedesc"><a name="rzaieapi_qzhtchgtcmdatasourcedesc"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Change Triggered Cache Manager Data Source Description (QzhtChgTCMDataSourceDesc)
|
||
|
|
API</h1>
|
||
|
|
<div><div class="important"><span class="importanttitle">Important:</span> Information
|
||
|
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
||
|
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
||
|
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
||
|
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">request variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">length of request variable</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">request variable format</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">server name</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(32)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">5</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">description name</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">Input</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(32)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="right" valign="top" width="6.313131313131313%">6</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">error code</td>
|
||
|
|
<td valign="top" width="31.060606060606062%">I/O</td>
|
||
|
|
<td valign="top" width="31.313131313131315%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="4" valign="top">Library Name/Service Program: QTCM/QZHTINCONF</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>Use the QzhtChgTCMDataSourceDesc API to change data source descriptions
|
||
|
|
associated with triggered cache manager servers. Changes made to data source
|
||
|
|
descriptions are utilized by all trigger handler descriptions that reference
|
||
|
|
them the next time the servers are started. The API is a callable service
|
||
|
|
implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM
|
||
|
|
*LIB. </p>
|
||
|
|
<p>The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.</p>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
|
||
|
|
<div><ul><li>*IOSYSCFG special authority</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>request variable</strong></dt>
|
||
|
|
<dd>INPUT: CHAR(*) <p>The variable used to pass the information used to change
|
||
|
|
a data source description. See Data source 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>DSDP0100: Basic information format for a data source description.</li>
|
||
|
|
<li>DSDP0200: Detailed information format for an *IFS type data source description.</li>
|
||
|
|
<li>DSDP0300: Detailed information format for a *HTTP1 type data source description.</li>
|
||
|
|
<li>DSDP0310: Detailed information format for a *HTTP2 type data source description.</li>
|
||
|
|
</ul>
|
||
|
|
<p>See Data source description formats for more information.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>server name</strong></dt>
|
||
|
|
<dd>The name used to identify the server for which the description is changed
|
||
|
|
(left justified and padded with blanks if necessary).</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm">description name</dt>
|
||
|
|
<dd>The name used to identify which data source description is changed (left
|
||
|
|
justified and padded with blanks if necessary).</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="dsdp0100_format"><a name="dsdp0100_format"><!-- --></a><h2 class="topictitle2">DSDP0100 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="d0e178">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e180">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e182">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e185">Dec</th>
|
||
|
|
<th valign="top" id="d0e187">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e178 d0e185 ">0</td>
|
||
|
|
<td valign="top" headers="d0e178 d0e187 ">0</td>
|
||
|
|
<td valign="top" headers="d0e180 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e182 ">Server name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e178 d0e185 ">32</td>
|
||
|
|
<td valign="top" headers="d0e178 d0e187 ">20</td>
|
||
|
|
<td valign="top" headers="d0e180 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e182 ">Data source description name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e178 d0e185 ">64</td>
|
||
|
|
<td valign="top" headers="d0e178 d0e187 ">40</td>
|
||
|
|
<td valign="top" headers="d0e180 ">Char(10)</td>
|
||
|
|
<td valign="top" headers="d0e182 ">Data source type</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e178 d0e185 ">74</td>
|
||
|
|
<td valign="top" headers="d0e178 d0e187 ">4A</td>
|
||
|
|
<td valign="top" headers="d0e180 ">Char(2)</td>
|
||
|
|
<td valign="top" headers="d0e182 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e178 d0e185 ">76</td>
|
||
|
|
<td valign="top" headers="d0e178 d0e187 ">4C</td>
|
||
|
|
<td valign="top" headers="d0e180 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e182 ">Default property</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e178 d0e185 ">80</td>
|
||
|
|
<td valign="top" headers="d0e178 d0e187 ">50</td>
|
||
|
|
<td valign="top" headers="d0e180 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e182 ">Number of threads</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="dsdp0100_field_descriptions"><a name="dsdp0100_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDP0100 format field descriptions</h2>
|
||
|
|
<div><div class="note"><span class="notetitle">Note:</span> Data source descriptions are added using default values for all unspecified
|
||
|
|
values according to the type specified by Data source type). See other data
|
||
|
|
source description formats for details regarding these default values.</div>
|
||
|
|
<dl><dt class="dlterm"><strong>Data source description name</strong></dt>
|
||
|
|
<dd>The name used by the new data source description (left justified and padded
|
||
|
|
with blanks if necessary).<p>Special values and their meanings are as follows:</p>
|
||
|
|
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
|
||
|
|
<dd>QZHT_NO_CHANGE_CHAR: The current type is not changed.</dd>
|
||
|
|
</dl>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Data source 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>Data source type</strong></dt>
|
||
|
|
<dd>The type of data source 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>*SAME</strong></dt>
|
||
|
|
<dd>QZHT_NO_CHANGE_CHAR: The description is not changed to a different type.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>*IFS</strong></dt>
|
||
|
|
<dd>QZHT_IFS_TYPE: The description is changed to an *IFS type data source
|
||
|
|
description.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>*HTTP1</strong></dt>
|
||
|
|
<dd>QZHT_HTTP_TYPE1: The description is changed to an *HTTP1 type data source
|
||
|
|
description.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>*HTTP2</strong></dt>
|
||
|
|
<dd>QZHT_HTTP_TYPE2: The description is changed to an *HTTP2 type data source
|
||
|
|
description.</dd>
|
||
|
|
</dl>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> If a specified type is different than the current type,
|
||
|
|
certain information is discarded if it cannot be mapped to values for reuse
|
||
|
|
by the new description type. See other data source description formats for
|
||
|
|
details.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Default property</strong></dt>
|
||
|
|
<dd>Specifies if the new description will become the default data source description
|
||
|
|
for the triggered cache manager server specified in Server name. The value
|
||
|
|
must equal one of the special values described below. If the value equals
|
||
|
|
1 (QZHT_YES), the default property on the current default data source description
|
||
|
|
is set to 0 (QZHT_NO). This description takes over the default role. 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.228426395939088%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">If a specified type is different than the current type,
|
||
|
|
certain information is discarded if it cannot be mapped to values for reuse
|
||
|
|
by the new description type. See other data source description formats for
|
||
|
|
details.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: The current value is not changed.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Trigger handler descriptions added or changed using the *DEFAULT
|
||
|
|
special value are referenced from this data source description designated
|
||
|
|
as default at the time the trigger handler descriptions are added or changed.</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 triggers sent to this trigger handler. The value must be greater
|
||
|
|
that 0 and less than 2<sup>31</sup> (or 2.147x10<tt>9</tt>), 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.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QQZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: The current value is not changed.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Server name</strong></dt>
|
||
|
|
<dd>The name used to identify the triggered cache manager server to which
|
||
|
|
the description is associated (left justified and padded with blanks if necessary).
|
||
|
|
The value must be a server name, or one of the special values described below.
|
||
|
|
If a server name is specified that is different than the one with which the
|
||
|
|
description is currently associated, it is removed from its current association
|
||
|
|
and added for the new server.<p>Special values and their meanings are as follows:</p>
|
||
|
|
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
|
||
|
|
<dd>QZHT_NO_CHANGE_CHAR: The current server association is not changed.<div class="note"><span class="notetitle">Note:</span> An
|
||
|
|
escape message is sent if the description is removed from its current association
|
||
|
|
while being referenced by other descriptions.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="dsdp0200_format"><a name="dsdp0200_format"><!-- --></a><h2 class="topictitle2">DSDP0200 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="d0e403">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e405">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e407">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e410">Dec</th>
|
||
|
|
<th valign="top" id="d0e412">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e403 d0e410 ">0</td>
|
||
|
|
<td valign="top" headers="d0e403 d0e412 ">0</td>
|
||
|
|
<td valign="top" headers="d0e405 "> </td>
|
||
|
|
<td valign="top" headers="d0e407 ">Everything from DSDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e403 d0e410 ">84</td>
|
||
|
|
<td valign="top" headers="d0e403 d0e412 ">54</td>
|
||
|
|
<td valign="top" headers="d0e405 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e407 ">Offset to local directory root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e403 d0e410 ">88</td>
|
||
|
|
<td valign="top" headers="d0e403 d0e412 ">58</td>
|
||
|
|
<td valign="top" headers="d0e405 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e407 ">Length of local directory root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e403 d0e410 "> </td>
|
||
|
|
<td valign="top" headers="d0e403 d0e412 "> </td>
|
||
|
|
<td valign="top" headers="d0e405 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e407 ">Local root directory</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="dsdp0200_field_descriptions"><a name="dsdp0200_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDP0200 format field descriptions</h2>
|
||
|
|
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *IFS, all information currently
|
||
|
|
stored for the description, that is not mapped for one the following entries,
|
||
|
|
is discarded.</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 data
|
||
|
|
source (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="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e480">If the current type is:</th>
|
||
|
|
<th valign="top" id="d0e482"> </th>
|
||
|
|
<th valign="top" id="d0e483">Details</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e480 ">*IFS</td>
|
||
|
|
<td valign="top" headers="d0e482 ">use current Local directory root path</td>
|
||
|
|
<td valign="top" headers="d0e483 ">No change is made</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e480 ">*HTTP1 or *HTTP2</td>
|
||
|
|
<td valign="top" headers="d0e482 ">use current HTTP URI root path</td>
|
||
|
|
<td valign="top" headers="d0e483 ">Refers to DSDP0300 or DSDP0310 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e480 ">any other</td>
|
||
|
|
<td valign="top" headers="d0e482 ">use default path</td>
|
||
|
|
<td valign="top" headers="d0e483 "> </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> All requests for files from the data source must have this path
|
||
|
|
prepended to the file name, even if an absolute path is specified for the
|
||
|
|
file. If the value is null, Offset to local directory root must equal 0 (QZHT_NONE)
|
||
|
|
or -1 (QZHT_DEFAULT).</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.228426395939088%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default path is used for Local directory
|
||
|
|
root.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: If the current description type is *IFS,
|
||
|
|
the current path for Local directory root is not changed. If the current description
|
||
|
|
type is not *IFS, see details for Local directory root on how current description
|
||
|
|
values are mapped for reuse by the new description type.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="dsdp0300_format"><a name="dsdp0300_format"><!-- --></a><h2 class="topictitle2">DSDP0300 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="d0e552">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e554">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e556">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e559">Dec</th>
|
||
|
|
<th valign="top" id="d0e561">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e552 d0e559 ">0</td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 ">0</td>
|
||
|
|
<td valign="top" headers="d0e554 ">Char(256)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">Everything from DSDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e552 d0e559 ">88</td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 ">58</td>
|
||
|
|
<td valign="top" headers="d0e554 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">HTTP IP interface</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e552 d0e559 ">340</td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 ">154</td>
|
||
|
|
<td valign="top" headers="d0e554 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">HTTP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e552 d0e559 ">344</td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 ">158</td>
|
||
|
|
<td valign="top" headers="d0e554 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">Offset to HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e552 d0e559 ">348</td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 ">15C</td>
|
||
|
|
<td valign="top" headers="d0e554 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">Length of HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e552 d0e559 ">352</td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 ">160</td>
|
||
|
|
<td valign="top" headers="d0e554 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">HTTP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e552 d0e559 ">356</td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 ">164</td>
|
||
|
|
<td valign="top" headers="d0e554 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">Timeout</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e552 d0e559 "> </td>
|
||
|
|
<td valign="top" headers="d0e552 d0e561 "> </td>
|
||
|
|
<td valign="top" headers="d0e554 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e556 ">HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="dsdp0300_field_descriptions"><a name="dsdp0300_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDP0300 format field descriptions</h2>
|
||
|
|
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *HTTP1, all information currently
|
||
|
|
stored for the description, that is not mapped for one the following entries,
|
||
|
|
is discarded.</div>
|
||
|
|
<dl><dt class="dlterm"><strong>HTTP IP interface</strong></dt>
|
||
|
|
<dd>The IP host name or address of the system hosting an HTTP server data
|
||
|
|
source (left justified and padded with blanks if necessary). The value must
|
||
|
|
be a host name (for example, server.mycompany.com), dotted address (for example,
|
||
|
|
192.168.3.57), or one of the special values described below. If a host name
|
||
|
|
is specified, it must use proper naming conventions as defined by RFC 1034,
|
||
|
|
Domain Names - Concepts and Facilities. If a dotted address is specified,
|
||
|
|
it must use proper IP version 4 address conventions as defined by RFC 791,
|
||
|
|
Internet Protocol. The default value is 127.0.0.1, the local system loopback
|
||
|
|
interface.<p>Special values and their meanings are as follows:</p>
|
||
|
|
<dl><dt class="dlterm"><strong>*DEFAULT</strong></dt>
|
||
|
|
<dd>QZHT_DEFAULT_CHAR: The default value is used.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
|
||
|
|
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
|
||
|
|
values for reuse.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e670">If the current type is:</th>
|
||
|
|
<th valign="top" id="d0e672"> </th>
|
||
|
|
<th valign="top" id="d0e673">Details</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e670 ">*HTTP1</td>
|
||
|
|
<td valign="top" headers="d0e672 ">use current HTTP IP interface value</td>
|
||
|
|
<td valign="top" headers="d0e673 ">No change is made.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e670 ">*HTTP2</td>
|
||
|
|
<td valign="top" headers="d0e672 ">use IP interface value from the host description currently
|
||
|
|
referenced by HTTP host An exception occurs if the referenced description
|
||
|
|
does not exist. Refers to the</td>
|
||
|
|
<td valign="top" headers="d0e673 ">An exception occurs if the referenced description does
|
||
|
|
not exist. Refers to the DSDP0310 format.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e670 ">any other</td>
|
||
|
|
<td valign="top" headers="d0e672 ">use default value</td>
|
||
|
|
<td valign="top" headers="d0e673 "> </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<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.228426395939088%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
|
||
|
|
kept open after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
|
||
|
|
closed after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: If the current description type is *HTTP1
|
||
|
|
or *HTTP2, the current value is not changed. If the current description type
|
||
|
|
is not *HTTP1 or *HTTP2, 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.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: The following rules are used to map
|
||
|
|
current description values for reuse.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e771">If the current type is:</th>
|
||
|
|
<th valign="top" id="d0e773"> </th>
|
||
|
|
<th valign="top" id="d0e774">Details</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e771 ">*HTTP1 or *HTTP2</td>
|
||
|
|
<td valign="top" headers="d0e773 ">use current HTTP TCP port value</td>
|
||
|
|
<td valign="top" headers="d0e774 ">No change is made</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e771 ">any other</td>
|
||
|
|
<td valign="top" headers="d0e773 ">use default value</td>
|
||
|
|
<td valign="top" headers="d0e774 "> </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 data source.</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 data source (left
|
||
|
|
justified and padded with blanks if necessary). The value must be a path acceptable
|
||
|
|
to HTTP Server. The default path is / .<p>If Offset to HTTP URI root equals
|
||
|
|
-2 (QZHT_NO_CHANGE), the following rules are used to map current description
|
||
|
|
values for reuse:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e808">If the current type is:</th>
|
||
|
|
<th valign="top" id="d0e810"> </th>
|
||
|
|
<th valign="top" id="d0e811">Details</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e808 ">*IFS</td>
|
||
|
|
<td valign="top" headers="d0e810 ">use current Local directory root path</td>
|
||
|
|
<td valign="top" headers="d0e811 ">Refers to DSDP0200 format.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e808 ">*HTTP1 or *HTTP2</td>
|
||
|
|
<td valign="top" headers="d0e810 ">use current HTTP URI root path</td>
|
||
|
|
<td valign="top" headers="d0e811 ">No change is made</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e808 ">any other</td>
|
||
|
|
<td valign="top" headers="d0e810 ">use default path</td>
|
||
|
|
<td valign="top" headers="d0e811 "> </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> All file requests from this data source 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).</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.228426395939088%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used for HTTP URI
|
||
|
|
root.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: If the current description type is *HTTP1
|
||
|
|
or *HTTP2, the current path for HTTP URI root is not changed. If the current
|
||
|
|
description type is not *HTTP1 or *HTTP2, see details for HTTP URI root on
|
||
|
|
how current description values are mapped for reuse by the new description
|
||
|
|
type.</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<tt>9</tt>), 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.228426395939088%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">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.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: If the current description type is *HTTP1
|
||
|
|
or *HTTP2, the current value is not changed. If the current description type
|
||
|
|
is not *HTTP1 or *HTTP2, the default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="dsdp0310_format"><a name="dsdp0310_format"><!-- --></a><h2 class="topictitle2">DSDP0310 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="d0e927">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e929">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e931">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e934">Dec</th>
|
||
|
|
<th valign="top" id="d0e936">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e927 d0e934 ">0</td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 ">0</td>
|
||
|
|
<td valign="top" headers="d0e929 "> </td>
|
||
|
|
<td valign="top" headers="d0e931 ">Everything from DSDP0100 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e927 d0e934 ">84</td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 ">54</td>
|
||
|
|
<td valign="top" headers="d0e929 ">Char(32)</td>
|
||
|
|
<td valign="top" headers="d0e931 ">HTTP host</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e927 d0e934 ">116</td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 ">74</td>
|
||
|
|
<td valign="top" headers="d0e929 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e931 ">HTTP TCP port</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e927 d0e934 ">120</td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 ">78</td>
|
||
|
|
<td valign="top" headers="d0e929 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e931 ">Offset to HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e927 d0e934 ">124</td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 ">7C</td>
|
||
|
|
<td valign="top" headers="d0e929 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e931 ">Length of HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e927 d0e934 ">128</td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 ">80</td>
|
||
|
|
<td valign="top" headers="d0e929 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e931 ">HTTP keepalive</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e927 d0e934 ">132</td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 ">84</td>
|
||
|
|
<td valign="top" headers="d0e929 ">Binary(4)</td>
|
||
|
|
<td valign="top" headers="d0e931 ">Timeout</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e927 d0e934 "> </td>
|
||
|
|
<td valign="top" headers="d0e927 d0e936 "> </td>
|
||
|
|
<td valign="top" headers="d0e929 ">Char(*)</td>
|
||
|
|
<td valign="top" headers="d0e931 ">HTTP URI root</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="dsdp0310_field_descriptions"><a name="dsdp0310_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDP0310 format field descriptions</h2>
|
||
|
|
<div><div class="note"><span class="notetitle">Note:</span> If the current description type is not *HTTP2, all information currently
|
||
|
|
stored for the description, that is not mapped to one the following entries,
|
||
|
|
is discarded.</div>
|
||
|
|
<dl><dt class="dlterm"><strong>HTTP host</strong></dt>
|
||
|
|
<dd>The name of a host description associated with the triggered cache manager
|
||
|
|
server that is referenced by the new data source description and used later,
|
||
|
|
at server startup, to obtain information about the system hosting an HTTP
|
||
|
|
server data source. The value must be a host description name, or one of the
|
||
|
|
special values described below (left justified and padded with blanks if necessary).
|
||
|
|
The default value is to reference the description currently designated as
|
||
|
|
the default host description for the triggered cache manager server.<p>Special
|
||
|
|
values and their meanings are as follows:</p>
|
||
|
|
<dl><dt class="dlterm"><strong>*DEFAULT</strong></dt>
|
||
|
|
<dd>QZHT_DEFAULT_CHAR: The default value is referenced.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>*SAME</strong></dt>
|
||
|
|
<dd>QZHT_NO_CHANGE_CHAR: The following rules are used to map current description
|
||
|
|
values for reuse.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1044">If the current type is:</th>
|
||
|
|
<th valign="top" id="d0e1046"> </th>
|
||
|
|
<th valign="top" id="d0e1047">Details</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e1044 ">*HTTP2</td>
|
||
|
|
<td valign="top" headers="d0e1046 ">the description currently referenced for HTTP host is
|
||
|
|
not changed </td>
|
||
|
|
<td valign="top" headers="d0e1047 ">No change is made.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1044 ">any other</td>
|
||
|
|
<td valign="top" headers="d0e1046 ">the default host description currently associated with
|
||
|
|
the triggered cache manager server is referenced</td>
|
||
|
|
<td valign="top" headers="d0e1047 "> </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> See HTTP TCP port for more information. An escape message is
|
||
|
|
sent if the referenced description does not currently exist, or if *DEFAULT
|
||
|
|
is specified and there is currently no default host description for the server.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>HTTP keepalive</strong></dt>
|
||
|
|
<dd>Specifies if connections to HTTP Server are kept open for reuse after
|
||
|
|
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.228426395939088%"><strong>1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The connection is
|
||
|
|
kept open after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The connection is
|
||
|
|
closed after data transfer.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: If the current description type is *HTTP1
|
||
|
|
or *HTTP2, the current value is not changed. If the current description type
|
||
|
|
is not *HTTP1 or *HTTP2, 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.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: The following rules are used to map
|
||
|
|
current description values for reuse.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1138">If the current type is:</th>
|
||
|
|
<th valign="top" id="d0e1140"> </th>
|
||
|
|
<th valign="top" id="d0e1141">Details</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e1138 ">*HTTP1 or *HTTP2</td>
|
||
|
|
<td valign="top" headers="d0e1140 ">use current HTTP TCP port value</td>
|
||
|
|
<td valign="top" headers="d0e1141 ">No change is made.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1138 ">any other</td>
|
||
|
|
<td valign="top" headers="d0e1140 ">use default value</td>
|
||
|
|
<td valign="top" headers="d0e1141 "> </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 data source.</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 data source (left
|
||
|
|
justified and padded with blanks if necessary). The value must be a path acceptable
|
||
|
|
to HTTP Server. The default path is / .<p>If Offset to HTTP URI root equals
|
||
|
|
-2 (QZHT_NO_CHANGE), the following rules are used to map current description
|
||
|
|
values for reuse:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e1175">If the current type is:</th>
|
||
|
|
<th valign="top" id="d0e1177"> </th>
|
||
|
|
<th valign="top" id="d0e1178">Details</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e1175 ">*IFS</td>
|
||
|
|
<td valign="top" headers="d0e1177 ">use current Local directory root path</td>
|
||
|
|
<td valign="top" headers="d0e1178 ">Refers to DSDP0200 format</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1175 ">*HTTP1 or *HTTP2</td>
|
||
|
|
<td valign="top" headers="d0e1177 ">use current HTTP URI root path</td>
|
||
|
|
<td valign="top" headers="d0e1178 ">No change is made</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e1175 ">any other</td>
|
||
|
|
<td valign="top" headers="d0e1177 ">use default path</td>
|
||
|
|
<td valign="top" headers="d0e1178 "> </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> All requests for files from this data source 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), -1 (QZHT_DEFAULT),
|
||
|
|
or -2 (QZHT_NO_CHANGE). See Offset to HTTP URI root for more details.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm"><strong>Length of HTTP URI root</strong></dt>
|
||
|
|
<dd>The length of the information for the HTTP URI root entry.<div class="note"><span class="notetitle">Note:</span> If Offset
|
||
|
|
to HTTP URI root equals 0 (QZHT_NONE), 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.228426395939088%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default path is used for HTTP URI
|
||
|
|
root.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: If the current description type is *HTTP1
|
||
|
|
or *HTTP2, the current path for HTTP URI root is not changed. If the current
|
||
|
|
description type is not *HTTP1 or *HTTP2, see details for HTTP URI root on
|
||
|
|
how current description values are mapped for reuse by the new description
|
||
|
|
type.</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.228426395939088%"><strong>0</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">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.228426395939088%"><strong>-1</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_DEFAULT: The default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" width="15.228426395939088%"><strong>-2</strong></td>
|
||
|
|
<td valign="top" width="84.77157360406092%">QZHT_NO_CHANGE: If the current description type is *HTTP1
|
||
|
|
or *HTTP2, the current value is not changed. If the current description type
|
||
|
|
is not *HTTP1 or *HTTP2, the default value is used.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
|
||
|
|
<div><dl><dt class="dlterm"><strong>TCM7001 E</strong></dt>
|
||
|
|
<dd>User &1 is not authorized.</dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt class="dlterm">TCM7030 E</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>TCM7290 E</strong></dt>
|
||
|
|
<dd>&1 &2 was not found for triggered cache manager server &3.</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>
|