TCP/IP Socket Listener Configuration File

3.19 TCP/IP Socket Listener Configuration File

This configuration file defines TCP/IP socket listener information. The following table lists its parameters.

The file name is listener.desc; it does not support dynamic configuration. The format is:

[ListenerGroupID]
<field_name_1>=<field_value_1>
<field_name_2>=<field_value_2>

Table 3-17 TCP/IP Socket Listener Parameters

Field Name	Type	Values	Description
`AF`	`X(5)`	`Optional`	Listener Address Family. Use `INET` (default) or `INET6`.
`APPLID`	`X(8)`	`Optional`	Reserved for future use. The `APPLID` for this listener.
`BACKLOG`	`Short`	`Optional`	The number of unaccepted connections that can be queued to this listener. The default value is `20`.
`CSDELAY`	`X(6)`	`Optional`	Reserved for future use. This parameter is specific to the enhanced version of the listener and is applicable only if `CSSTTYP` is `IC`. It specifies the delay interval to be used on the `EXEC CICS START` command, in the form `hhmmss` (hours/minutes/seconds).
`CSSTTYP`	`X(2)`	`Optional`(Used in enhanced mode)	This parameter is specific to the enhanced version of the listener and specifies the default start method for the user transaction. Only supports `KC` value (default), indicating that the user transaction is started using `EXEC CICS START` with no delay interval.
`CSTRAN`	`X(4)`	`Optional`(Mandatory in enhanced mode)	This parameter is specific to the enhanced version of the listener and specifies the default transaction that the listener starts in `ARTATRN/ARTATR1`.
`FORMAT`	`X(8)`	`Optional`	Mode of the listener. The default value of `STANDARD` indicates that this is the original ART for CICS listener that requires the client to send the standard header. The value of `ENHANCED` indicates that this is the enhanced ART for CICS listener that does not expect the standard header from the client.
`GIVTIME`	`Short`	`Optional`	The time in seconds this listener waits for a response to a `TAKESOCKET`. If this time expires, the listener assumes that either the server transaction did not start or the `TAKESOCKET` failed. At this time, the listener sends the client a message indicating the server failed to start and close the socket (connection). The default value is `60`.
`IPADDRESS`	`X(46)`	`Optional`	IP address.
`MSGLEN`	`Short`	`Optional`(Used in enhanced mode)	This parameter is specific to the enhanced version of the listener and specifies the length of the data to be received from the client. The valid range is `0` to `999` byte. If the value is `0`, the listener does not read in any data from the client.
`PEEKDAT`	`Short`	`Optional`(Used in enhanced mode)	This parameter is specific to the enhanced version of the listener and applies only if `MSGLEN` is not `0`. A value of `NO` indicates that the listener performs a normal read of the client data. The user transaction accesses this data in the data area-2 portion of the transaction input message (TIM). A value of `YES` indicates that the listener reads the data using the peek option; the data remains queued in TCP/IP and the user transaction actually read it in rather than accessing it through the TIM.
`PORT`	`short`	`Mandatory`	The port number this listener uses for accepting connections.
`REATIME`	`Short`	`optional`	The time in seconds this listener waits for a response to a `RECV` request. If this time expires, the listener assumes that the client has failed and terminates the connection by closing the socket. If this parameter is not specified, checking for read timeout is not performed.
`TRANID`	`X(4)`	`optional`	Reserved for future use. The transaction name for this listener.
`TYPE`	`X(3)`	`optional`	Type of the created socket. Only supports `TCP`.

Parent topic: CICS Runtime Configuration Files