Change Triggered Cache Manager Basic Configuration (QzhtChgTCMBasicConfig) API

Important: 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 http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm Link outside Information Center for more information.
Required Parameter Group:
1 request variable Input Char(*)
2 length of request variable Input Binary(4)
3 request variable format Input Char(8)
4 error code I/O Char(*)
Library Name/Service Program: QTCM/QZHTINCONF
Threadsafe: Yes

Use the QzhtChgTCMBasicConfig API to change the basic configuration information for a triggered cache manager server. The API is a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB.

The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.

Authorities and locks

Required parameter group

request variable
INPUT: CHAR(*)

The variable used to pass the information used to change the basic configuration information for a triggered cache manager server.

length of request variable
INPUT: BINARY(4)

The number of bytes that the calling program provides for request variable.

request variable format
INPUT: CHAR(8)

The format name of the request variable data. The following values must be used:

  • INDP0200: Detailed information format for server data.
error code
I/O: CHAR(*)

The structure in which to return error information.

INDP0200 format

Offset Type Field
Dec Hex
0 0 Char(32) Server name
32 20 Binary(4) Autostart property
36 24 Binary(4) Local TCP port
40 28 Binary(4) Offset to root directory
44 2C Binary(4) Length of root directory
48 30 Binary(4) Maximum number of retries
52 34 Binary(4) Defer time between retries
56 38 Binary(4) Memory buffer size
    Char(*) Root directory

Field descriptions

Autostart property
Specifies if the new triggered cache manager server is to start when startup of *AUTOSTART triggered cache manager servers, is requested. Usually *AUTOSTART servers are requested to start when TCP/IP is started, however they may also be requested via the STRTCPSVR command or QzhtStrTCMServer API. The default value is 0 (QZHT_NO).

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The server is set to start when startup of *AUTOSTART servers is requested.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The server is not set to start when startup of *AUTOSTART servers is requested.
-1 QZHT_DEFAULT: The default value is used.
-2 QZHT_NO_CHANGE: No change is made to the current auto start setting.
Defer time between retries
The number of seconds the triggered cache manager server is to wait between retry attempts for a failing action. The value must be greater than 0 and less than 231 (or 2.147x109), or equal to one of the special values described below. The default value is 60.

Special values and their meanings are as follows:

0 QZHT_NONE: No defer time is to be used.
-1 QZHT_DEFAULT: The default value is to be used.
-2 QZHT_NO_CHANGE: The current defer time value is not to be changed.
Note: If maximum number of retries is equal to 0 (QZHT_NONE), this value must be equal to 0 (QZHT_NONE).
Length of root directory
The length of the information for the root directory entry.
Note: If offset to root directory is equal to 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE), this value must be equal to 0.
Maximum number of retries
The maximum number of time the server will attempt to retry a failing action. The value must be greater than 0 and less than 231 (or 2.147x109), or equal to one of the special values described below. The default is to retry failing actions until successful (QZHT_NOMAX).

Special values and their meanings are as follows:

0 QZHT_NONE: Do not retry failing actions.
-1 QZHT_DEFAULT: The default action is specified.
-2 QZHT_NO_CHANGE: The current maximum number of retries value is not to be changed.
-3 QZHT_NOMAX: Failing actions are to be retried until successful.
Memory buffer size
The maximum amount of working data the triggered cache manager server attempts to store in memory, in bytes. The value must be greater than -1 and less than 231 (or 2.147x109), or equal to one of the special values described below. A value equal to 0 indicates that the new triggered cache manager server should attempt to run in the least memory possible. The default value is 10,000,000 (or 1x107).

Special values and their meanings are as follows:

-1 QZHT_DEFAULT: The default value is to be used.
-2 QZHT_NO_CHANGE: The current memory buffer size value is not to be changed.
Offset to root directory
The offset from the beginning of the request variable to the Root directory data, in bytes. The value must be greater than 0, or equal to one of the special values described below.

Special values and their meanings are as follows:

0 QZHT_NONE: Same as -2 (QZHT_NO_CHANGE).
-1 QZHT_DEFAULT: The default value is to be used for Root directory. The value for Root directory is null.
-2 QZHT_NO_CHANGE: The current root directory name is not to be changed for Root directory. The value for Root directory is null.
Root directory
The name of the local file system directory in which the triggered cache manager server is to maintain its persistent record of incoming transactions. The value must be null, or specify a directory name, left justified and padded with blanks if necessary. The default name is /QIBM/UserData/TCM/{servername}/ root, where {server-name} is the name of the server as defined by Server name.
Note: If the value is null, Offset to root directory must be set to 0 (QZHT_NONE), -1 (QZHT_DEFAULT), or -2 (QZHT_NO_CHANGE).
Server name
The name used to identify the server for which the configuration change is made (left justified and padded with blanks if necessary).

Error messages

TCM7001 E
User &1 is not authorized.
TCM7030 E
Severe error occurred while addressing parameter list.
TCM7031 E
Request variable format is not valid.
TCM7033 E
Length of request variable is not valid for the specified format.
TCM703E E
Error code parameter is not valid
TCM70F0 E
Unknown error occurred while processing request.
TCM7101 E
User QTCM is not authorized to the configuration file for triggered cache manager server &1.
TCM7190 E
A configuration file for triggered cache manager server &1 was not found.
TCM72C3 E
Value passed to offset &1 is not valid.
TCM74C0 E
Triggered cache manager server name is not valid.