Create Triggered Cache Manager Server (QzhtCrtTCMServer) 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 QzhtCrtTCMServer API to create triggered cache manager servers. Configuration information associated with servers is stored separately for each 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

*IOSYSCFG special authority

Required parameter group

request variable: INPUT: CHAR(*)
The variable used to pass information used to create a new triggered cache manager servers.

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 Request variable data. The following values must be used:

INDP0100: Basing server information for server data.

error code: I/O: CHAR(*)
The structure in which to return error information.

INDP0100 format

Offset		Type	Field
Dec	Hex	Type	Field
0	0	Char(32)	Server name
32	20	Binary(4)	Autostart property
36	24	Binary(4)	Local TCP port
40	28	Char(32)	Basing server

Field descriptions

Server name: The name used by the new triggered cache manager server (left justified and padded with blanks if necessary).
Note: Server names must be unique.

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 new server is to start when startup of *AUTOSTART servers is requested.
0	QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The new server is not to start when startup of *AUTOSTART servers is requested.
-1	QZHT_DEFAULT: The default value is used.

Local TCP port

The TCP port number used by the new triggered cache manager server. The value must be greater than 0 and less than 65536, or equal the special value described below. The default value is 7049.

The special value and its meaning is as follows:

-1	QZHT_DEFAULT: The default value is used.

Note: Triggered cache manager servers use the same port number for all IP interfaces.

Basing server

The name of an existing triggered cache manager server from which all configuration data is obtained and used to create the new triggered cache manager server (left justified and padded with blanks if necessary). The value must be the name of an existing triggered cache manager server, or one of the special values described below. If the *DEFAULT special value is used, the default configuration is used to create the new triggered cache manager server.

The special value and its meaning is as follows:

*Default: QZHT_DEFAULT_CHAR: The default configuration is used for the new server.

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 format specified.

TCM703E E: Error code parameter is not valid.

TCM70F0 E: Unknown error occurred while processing request.

TCM7103 E: User QTCM is not authorized to the configuration file for the basing triggered cache manager server &1.

TCM7193 E: A configuration file for the basing triggered cache manager server &1 was not found.

TCM72C3 E: Value passed at offset &1 is not valid.

TCM4937 E: Triggered cache manager server using name &1 already exists.

TCM74C0 E: Triggered cache manager server name is not valid.

TCM734C3 E: Basing triggered cache manager server name is not valid.