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

578 lines
27 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="topic" />
<meta name="DC.Title" content="Retrieve Triggered Cache Manager Data Source Description (QzhtRtvTCMDataSourceDesc) 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_qzhtrtvtcmdatasourcedesc" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Retrieve Triggered Cache Manager Data Source Description (QzhtRtvTCMDataSourceDesc)
API</title>
</head>
<body id="rzaieapi_qzhtrtvtcmdatasourcedesc"><a name="rzaieapi_qzhtrtvtcmdatasourcedesc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Retrieve Triggered Cache Manager Data Source Description (QzhtRtvTCMDataSourceDesc)
API</h1>
<div><div class="important"><span class="importanttitle">Important:</span> Information
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
It is recommended that you install the latest PTFs to upgrade to the latest
level of the HTTP Server for i5/OS. Some of the topics documented here are
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
<td valign="top" width="31.313131313131315%">receiver variable</td>
<td valign="top" width="31.060606060606062%">Output</td>
<td valign="top" width="31.313131313131315%">Char(*)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
<td valign="top" width="31.313131313131315%">length of receiver variable</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Binary(4)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
<td valign="top" width="31.313131313131315%">receiver variable format</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(8)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
<td valign="top" width="31.313131313131315%">server name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(32)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">5</td>
<td valign="top" width="31.313131313131315%">description name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(32)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">6</td>
<td valign="top" width="31.313131313131315%">error code</td>
<td valign="top" width="31.060606060606062%">I/O</td>
<td valign="top" width="31.313131313131315%">Char(*)</td>
</tr>
<tr><td colspan="4" valign="top">Library Name/Service Program: QTCM/QZHTINCONF</td>
</tr>
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
</tr>
</tbody>
</table>
</div>
<p>Use the QzhtRtvTCMDataSourceDesc API to retrieve information from data
source descriptions associated with triggered cache manager servers. The API
is a callable service implemented as an ILE entry point within the QZHTINCONF
*SRVPGM in the QTCM *LIB. </p>
<p>The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.</p>
</div>
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
<div><ul><li>*IOSYSCFG special authority</li>
</ul>
</div>
</div>
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
<div><dl><dt class="dlterm"><strong>receiver variable</strong></dt>
<dd>OUTPUT: CHAR(*) <p>The variable used to return data source description
information. See Data source description formats for more information.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>length of receiver variable</strong></dt>
<dd>INPUT: BINARY(4)<p>The number of bytes that the calling program provides
for Receiver variable. This value must be greater than or equal to 8.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>receiver variable format</strong></dt>
<dd>INPUT: CHAR(8) <p>The format name of Receiver variable data. The following
values must be used:</p>
<ul><li>DSDG0100: Basic information format for data source description.</li>
<li>DSDG0200: Detailed information format for an *IFS type data source description.</li>
<li>DSDG0300: Detailed information format for an *HTTP1 type data source description.</li>
<li>DSDG0310: Detailed information format for an *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>INPUT: CHAR(32)<p>The name used to identify the server from which information
is retrieved (left justified and padded with blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>error code</strong></dt>
<dd>I/O: CHAR(*)<p>The structure in which to return error information.</p>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="dsdg0100_format"><a name="dsdg0100_format"><!-- --></a><h2 class="topictitle2">DSDG0100 format</h2>
<div><p>When the data source description type is unknown, use the DSDG0100 format
and the basic information (including data source type) is returned. You may
then use the returned data source type to call the API again and return detailed
information about the data source description using one of the detailed information
formats.</p>
<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="d0e176">Offset</th>
<th rowspan="2" valign="top" id="d0e178">Type</th>
<th rowspan="2" valign="top" id="d0e180">Field</th>
</tr>
<tr><th valign="top" id="d0e183">Dec</th>
<th valign="top" id="d0e185">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e176 d0e183 ">0</td>
<td valign="top" headers="d0e176 d0e185 ">0</td>
<td valign="top" headers="d0e178 ">Binary(4)</td>
<td valign="top" headers="d0e180 ">Bytes returned</td>
</tr>
<tr><td valign="top" headers="d0e176 d0e183 ">4</td>
<td valign="top" headers="d0e176 d0e185 ">4</td>
<td valign="top" headers="d0e178 ">Binary(4)</td>
<td valign="top" headers="d0e180 ">Bytes available</td>
</tr>
<tr><td valign="top" headers="d0e176 d0e183 ">8</td>
<td valign="top" headers="d0e176 d0e185 ">8</td>
<td valign="top" headers="d0e178 ">Char(32)</td>
<td valign="top" headers="d0e180 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e176 d0e183 ">40</td>
<td valign="top" headers="d0e176 d0e185 ">28</td>
<td valign="top" headers="d0e178 ">Char(32)</td>
<td valign="top" headers="d0e180 ">Data source description name</td>
</tr>
<tr><td valign="top" headers="d0e176 d0e183 ">72</td>
<td valign="top" headers="d0e176 d0e185 ">48</td>
<td valign="top" headers="d0e178 ">Char(10)</td>
<td valign="top" headers="d0e180 ">Data source type</td>
</tr>
<tr><td valign="top" headers="d0e176 d0e183 ">82</td>
<td valign="top" headers="d0e176 d0e185 ">52</td>
<td valign="top" headers="d0e178 ">Char(2)</td>
<td valign="top" headers="d0e180 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e176 d0e183 ">84</td>
<td valign="top" headers="d0e176 d0e185 ">54</td>
<td valign="top" headers="d0e178 ">Binary(4)</td>
<td valign="top" headers="d0e180 ">Default property</td>
</tr>
<tr><td valign="top" headers="d0e176 d0e183 ">88</td>
<td valign="top" headers="d0e176 d0e185 ">58</td>
<td valign="top" headers="d0e178 ">Binary(4)</td>
<td valign="top" headers="d0e180 ">Number of threads</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="dsdg0100_field_descriptions"><a name="dsdg0100_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDG0100 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Bytes available</strong></dt>
<dd>The number of information bytes available for return to the caller of
the API.<div class="note"><span class="notetitle">Note:</span> If this value is greater than the value of Bytes returned, the
receiver variable was not large enough to return all information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Bytes returned</strong></dt>
<dd>The number of information bytes returned to the caller of the API.</dd>
</dl>
<dl><dt class="dlterm"><strong>Data source description name</strong></dt>
<dd>The data source description name (left justified and padded with blanks
if necessary).</dd>
</dl>
<dl><dt class="dlterm"><strong>Data source type</strong></dt>
<dd>The data source description type (left justified and padded with blanks
if necessary). The returned value is one of the special values below.<p>Special
values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*IFS</strong></dt>
<dd>QZHT_IFS_TYPE</dd>
</dl>
<dl><dt class="dlterm"><strong>*HTTP1</strong></dt>
<dd>QZHT_HTTP_TYPE1</dd>
</dl>
<dl><dt class="dlterm"><strong>*HTTP2</strong></dt>
<dd>QZHT_HTTP_TYPE2</dd>
</dl>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Default property</strong></dt>
<dd>Indicates whether the description is the current default data source description
for the triggered cache manager server specified in Server name. The returned
value equals 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.736040609137056%"><strong>1</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is
the current default for this server.</td>
</tr>
<tr><td valign="top" width="15.736040609137056%"><strong>0</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description
is not the current default.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Number of threads</strong></dt>
<dd>The number of concurrent threads the triggered cache manager server spawns
when processing requests that receive data from this data source. The value
must be greater that 0 and less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>).</dd>
</dl>
<dl><dt class="dlterm"><strong>Server name</strong></dt>
<dd>The name of the triggered cache manager server with which the description
is associated (left justified and padded with blanks if necessary).</dd>
</dl>
</div>
</div>
<div class="nested1" id="dsdg0200_format"><a name="dsdg0200_format"><!-- --></a><h2 class="topictitle2">DSDG0200 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="d0e375">Offset</th>
<th rowspan="2" valign="top" id="d0e377">Type</th>
<th rowspan="2" valign="top" id="d0e379">Field</th>
</tr>
<tr><th valign="top" id="d0e382">Dec</th>
<th valign="top" id="d0e384">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e375 d0e382 ">0</td>
<td valign="top" headers="d0e375 d0e384 ">0</td>
<td valign="top" headers="d0e377 ">&nbsp;</td>
<td valign="top" headers="d0e379 ">Everything from DSDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e375 d0e382 ">92</td>
<td valign="top" headers="d0e375 d0e384 ">5C</td>
<td valign="top" headers="d0e377 ">Binary(4)</td>
<td valign="top" headers="d0e379 ">Offset to local directory root</td>
</tr>
<tr><td valign="top" headers="d0e375 d0e382 ">96</td>
<td valign="top" headers="d0e375 d0e384 ">60</td>
<td valign="top" headers="d0e377 ">Binary(4)</td>
<td valign="top" headers="d0e379 ">Length of local directory root</td>
</tr>
<tr><td valign="top" headers="d0e375 d0e382 ">&nbsp;</td>
<td valign="top" headers="d0e375 d0e384 ">&nbsp;</td>
<td valign="top" headers="d0e377 ">Char(*)</td>
<td valign="top" headers="d0e379 ">Local directory root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="dsdg0200_field_descriptions"><a name="dsdg0200_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDG0200 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Length of local directory root</strong></dt>
<dd>The length of the information for the Local directory root entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Local directory root</strong></dt>
<dd>The path to the local file system directory that defines the root for
this data source (left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> All
file requests from this data source have this path prepended to the file name,
even if an absolute path for the file is specified.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to local directory root</strong></dt>
<dd>The offset from the beginning of the receiver variable to the Local directory
root data, in bytes.</dd>
</dl>
</div>
</div>
<div class="nested1" id="dsdg0300_format"><a name="dsdg0300_format"><!-- --></a><h2 class="topictitle2">DSDG0300 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="d0e459">Offset</th>
<th rowspan="2" valign="top" id="d0e461">Type</th>
<th rowspan="2" valign="top" id="d0e463">Field</th>
</tr>
<tr><th valign="top" id="d0e466">Dec</th>
<th valign="top" id="d0e468">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e459 d0e466 ">0</td>
<td valign="top" headers="d0e459 d0e468 ">0</td>
<td valign="top" headers="d0e461 ">&nbsp;</td>
<td valign="top" headers="d0e463 ">Everything from DSDG0100 format</td>
</tr>
<tr><td valign="top" headers="d0e459 d0e466 ">92</td>
<td valign="top" headers="d0e459 d0e468 ">5C</td>
<td valign="top" headers="d0e461 ">Char(256)</td>
<td valign="top" headers="d0e463 ">HTTP IP interface</td>
</tr>
<tr><td valign="top" headers="d0e459 d0e466 ">348</td>
<td valign="top" headers="d0e459 d0e468 ">15C</td>
<td valign="top" headers="d0e461 ">Binary(4)</td>
<td valign="top" headers="d0e463 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e459 d0e466 ">352</td>
<td valign="top" headers="d0e459 d0e468 ">160</td>
<td valign="top" headers="d0e461 ">Binary(4)</td>
<td valign="top" headers="d0e463 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e459 d0e466 ">356</td>
<td valign="top" headers="d0e459 d0e468 ">164</td>
<td valign="top" headers="d0e461 ">Binary(4)</td>
<td valign="top" headers="d0e463 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e459 d0e466 ">360</td>
<td valign="top" headers="d0e459 d0e468 ">168</td>
<td valign="top" headers="d0e461 ">Binary(4)</td>
<td valign="top" headers="d0e463 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e459 d0e466 ">364</td>
<td valign="top" headers="d0e459 d0e468 ">16C</td>
<td valign="top" headers="d0e461 ">Binary(4)</td>
<td valign="top" headers="d0e463 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e459 d0e466 ">&nbsp;</td>
<td valign="top" headers="d0e459 d0e468 ">&nbsp;</td>
<td valign="top" headers="d0e461 ">Char(*)</td>
<td valign="top" headers="d0e463 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="dsdg0300_field_descriptions"><a name="dsdg0300_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDG0300 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 data
source (left justified and padded with blanks if necessary). The returned
value is either an IP host name (for example, server.mycompany.com) or dotted
IP address (for example, 192.168.3.57) (left justified and padded with blanks
if necessary).<div class="note"><span class="notetitle">Note:</span> See HTTP TCP port for more information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP keepalive</strong></dt>
<dd>Indicates whether the triggered cache manager server attempts to keep
connections to HTTP Server open for reuse after data is transferred. The returned
value equals one of the special values described below. <p>Special values
and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.736040609137056%"><strong>1</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The server attempts
to keep connections open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.736040609137056%"><strong>0</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The server closes
each connection after data transfer.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP TCP port</strong></dt>
<dd>The TCP listening port number used by HTTP Server data source. The value
returned is greater than 0 and less than 65536.<div class="note"><span class="notetitle">Note:</span> The returned TCP port
number is used in combination with the IP host name or address returned 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>HTTP Server URI path that defines the root for this data source (left
justified and padded with blanks if necessary).<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.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP URI root</strong></dt>
<dd>The length of the information returned for the HTTP URI root entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the receiver variable to the HTTP URI
root data, in bytes.</dd>
</dl>
<dl><dt class="dlterm"><strong>Timeout</strong></dt>
<dd>The number of seconds the triggered cache manager server waits before
canceling a read operation on sockets and ending transactions, with the HTTP
host, in error. The value must be greater than 0 and less than 2<sup>31</sup> (or
2.147x10<sup>9</sup>), or equal to one of the special values described below. <p>Special
values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.736040609137056%"><strong>0</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The time out operation
is disabled. The triggered cache manager server should never cancel a read
operation.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="dsdg0310_format"><a name="dsdg0310_format"><!-- --></a><h2 class="topictitle2">DSDG0310 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="d0e649">Offset</th>
<th rowspan="2" valign="top" id="d0e651">Type</th>
<th rowspan="2" valign="top" id="d0e653">Field</th>
</tr>
<tr><th valign="top" id="d0e656">Dec</th>
<th valign="top" id="d0e658">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e649 d0e656 ">0</td>
<td valign="top" headers="d0e649 d0e658 ">0</td>
<td valign="top" headers="d0e651 ">&nbsp;</td>
<td valign="top" headers="d0e653 ">Everything from DSDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e649 d0e656 ">92</td>
<td valign="top" headers="d0e649 d0e658 ">5C</td>
<td valign="top" headers="d0e651 ">Char(32)</td>
<td valign="top" headers="d0e653 ">HTTP host</td>
</tr>
<tr><td valign="top" headers="d0e649 d0e656 ">124</td>
<td valign="top" headers="d0e649 d0e658 ">7C</td>
<td valign="top" headers="d0e651 ">Binary(4)</td>
<td valign="top" headers="d0e653 ">HTTP TCP port</td>
</tr>
<tr><td valign="top" headers="d0e649 d0e656 ">128</td>
<td valign="top" headers="d0e649 d0e658 ">80</td>
<td valign="top" headers="d0e651 ">Binary(4)</td>
<td valign="top" headers="d0e653 ">Offset to HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e649 d0e656 ">132</td>
<td valign="top" headers="d0e649 d0e658 ">84</td>
<td valign="top" headers="d0e651 ">Binary(4)</td>
<td valign="top" headers="d0e653 ">Length of HTTP URI root</td>
</tr>
<tr><td valign="top" headers="d0e649 d0e656 ">136</td>
<td valign="top" headers="d0e649 d0e658 ">88</td>
<td valign="top" headers="d0e651 ">Binary(4)</td>
<td valign="top" headers="d0e653 ">HTTP keepalive</td>
</tr>
<tr><td valign="top" headers="d0e649 d0e656 ">140</td>
<td valign="top" headers="d0e649 d0e658 ">8C</td>
<td valign="top" headers="d0e651 ">Binary(4)</td>
<td valign="top" headers="d0e653 ">Timeout</td>
</tr>
<tr><td valign="top" headers="d0e649 d0e656 ">&nbsp;</td>
<td valign="top" headers="d0e649 d0e658 ">&nbsp;</td>
<td valign="top" headers="d0e651 ">Char(*)</td>
<td valign="top" headers="d0e653 ">HTTP URI root</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="dsdg0310_field_descriptions"><a name="dsdg0310_field_descriptions"><!-- --></a><h2 class="topictitle2">DSDG0310 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>HTTP host</strong></dt>
<dd>The name of the host description referenced by the data source description
and used, at server startup, to obtain information about the system hosting
an HTTP Server data source. The returned value is a host description name
(left justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> See HTTP TCP port
for more information. The referenced host description may or may not currently
exist. It is possible that it was removed or associated with a different triggered
cache manager server after the data source description was last modified.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP keepalive</strong></dt>
<dd>Indicates whether the triggered cache manager server attempts to keep
connections to HTTP Server open for reuse after data is transferred. The returned
value equals one of the special values described below. <p>Special values
and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.736040609137056%"><strong>1</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The server attempts
to keep connections open after data transfer.</td>
</tr>
<tr><td valign="top" width="15.736040609137056%"><strong>0</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The server closes
each connection after data transfer.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>HTTP TCP port</strong></dt>
<dd>The TCP listening port number used by HTTP Server data source. The returned
value is greater than 0 and less than 65536.<div class="note"><span class="notetitle">Note:</span> The returned TCP port number
is used in combination with the IP host name or address returned 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>HTTP Server URI path that defines the root for this data source (left
justified and padded with blanks if necessary).<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.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of HTTP URI root</strong></dt>
<dd>The length of the information returned for the HTTP URI root entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to HTTP URI root</strong></dt>
<dd>The offset from the beginning of the receiver variable to the HTTP URI
root data, in bytes.</dd>
</dl>
<dl><dt class="dlterm"><strong>Timeout</strong></dt>
<dd>The number of seconds the triggered cache manager server waits before
canceling a read operation on sockets and ending transactions, with the HTTP
host, in error. The value must be greater than 0 and less than 2<sup>31</sup> (or
2.147x10<sup>9</sup>), or equal to one of the special values described below. <p>Special
values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.736040609137056%"><strong>0</strong></td>
<td valign="top" width="84.26395939086294%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The time out operation
is disabled. The triggered cache manager server should never cancel a read
operation.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
<div><dl><dt class="dlterm"><strong>TCM7001 E</strong></dt>
<dd>User &amp;1 is not authorized.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7030 E</strong></dt>
<dd>Severe error occurred while addressing parameter list.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7032 E</strong></dt>
<dd>Receiver variable format is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7034 E</strong></dt>
<dd>Length of receiver variable is not valid for the specified format.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7035 E</strong></dt>
<dd>Server parameter is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7036 E</strong></dt>
<dd>Description parameter is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM703E E</strong></dt>
<dd>Error code parameter is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM70F0 E</strong></dt>
<dd>Unknown error occurred while processing request.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7101 E</strong></dt>
<dd>User QTCM is not authorized to the configuration file for triggered cache
manager server &amp;1.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
<dd>A configuration file for triggered cache manager server &amp;1 was not
found.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7290 E</strong></dt>
<dd>&amp;1 &amp;2 was not found for triggered cache manager server &amp;3.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink