Previous Topic: SOCKET SyntaxNext Topic: SOCKET Usage


SOCKET Parameters

LINE Statement Parameters

TYPe is SOCKET

Identifies the line as a TCP/IP line. An active SOCKET line is required to run any program that uses TCP/IP sockets.

plug-in

Name of the plug-in module that implements support for specific TCP/IP stack implementations. Possible values are:

RHDCD1IP

Supports most common TCP/IP stack implementations, including CA TCPaccess CS for z/OS, IBM TCP/IP and their run time equivalents.

RHDCD2IP, RHDCD3IP and RHDCD4IP

Names reserved for future implementations.

Note: As of r17, the plug-in parameter, if specified, is ignored to provide backward compatibility with r16. It is defined through the PLUGIN MODULE clause in the new TCP/IP SYSGEN entity.

LISTENER PTERM Statement Parameters

TYPE is LISTENER

Indicates that the physical terminal is a TCP/IP listener.

listener-port-identifier

Specifies the number of the listener port or a service name. If listener-port-identifier is a port number, it must be a positive number between 1 and 65535. If listener-port-identifier is a service name, it is limited to 32 characters and must be the name of a service in the services file with an associated protocol of TCP.

backlog

The value defines the maximum length for the queue of pending connections TCP/IP allows before disallowing connection requests. Backlog is a positive number between 1 and 1,147,483,647. The default value is 5.

The value specified for backlog is not necessarily the value accepted by the LISTEN call. Each TCP/IP implementation has a limit of its own. CA IDMS uses the lesser of the implementation's limit and the value specified for the backlog parameter.

stack-ip-name

The job name of the TCP/IP stack. The name is limited to 8 characters.

Specifying *ALL on a multi-homed system (z/OS only) causes listening to all active TCP/IP stacks. Specifying *DEFAULT causes listening to the default TCP/IP stack.

'stack-ip-address'

IP address of the host. The limit of an IP address depends on whether IPv4 or IPv6 is used: the limit in IPv4 is 15 characters; in IPv6, it is 45 characters.

stack-host-name

Name of the host. The maximum host name length is 64 characters.

task-code

Name of the task code to start when a connection request arrives.

MODE IS USER or SYSTEM

Indicates whether the task attached by the listener executes in SYSTEM or USER MODE. To execute in SYSTEM mode, the program must be fully reentrant and be written in either of the following:

string

A string is passed to the task attached by the generic listener. The string is limited to 80 characters.

max-number-conn

Defines the maximum number of active connections that can be started from the corresponding listener program, that is, the maximum number of active BULK PTERMs allocated by the specific LISTENER. When the number of connections reaches the value specified for max-number-conn, any new connection accepted by the listener program will be rejected.

max-number-conn is a positive number between 1 and 65535. The default value is OFF, indicating that the maximum number of connections is unlimited.

For information about the options that can be specified for the CA IDMS Server listener, see the following Usage section.

DDSTCPIP PTERM Parameters

TYPe is DDSTCPIP

Defines the target system for the DDS connection.

TARget

The target-ip-address and target-host-name parameters are mutually exclusive. You must specify at least one of these parameters in the definition of a DDSTCPIP type PTERM.

target-ip-address

Specifies the IP address of the target system enclosed in single quotes. The IP address limit depends on whether IPv4 or IPv6 is used: IPv4 is 15 characters; IPv6 is 45 characters.

target-host-name

Specifies the host name of the target system. The maximum host name length is 64 characters.

target-port-identifier

Specifies the number of the target port or a service name. If target-port-identifier is a port number, it must be a positive number between 1 and 65535. If target-port-identifier is a service name, it is limited to 32 characters and must be the name of a service in the services file with an associated protocol of TCP.

stack-ip-name

Specifies the job name of the TCP/IP stack to use in the local system. The job name is limited to 8 characters. Specify an empty string value (two single-quotes) to remove an IP STACK NAME definition.

start-port-number and end-port-number

Defines a range of port numbers that are used to BIND the local sockets explicitly. Each time a new connection is established, the first free port from the range is selected and associated (bound) with the corresponding socket. If no free port is found, the request is aborted.

The default value is OFF, indicating that the operating system will select a free port from the pool and bind the socket implicitly during the connect processing. start-port-number and end-port-number are positive numbers between 1 and 65535. start-port-number must be lower than or equal to end-port-number.

idle-interval

Defines the time interval a non-permanent connection stays in an idle state after the corresponding DDS request has finished. This allows the same connection to be reused if a new DDS request comes in before the timeout expires.

idle-interval is a positive number between 0 and 32767. The default value is 0.

max-number-conn

Defines the maximum number of active connections allowed from the local system.

max-number-conn is a positive number between 1 and 65535. The default value is OFF, indicating that the maximum number of connections is unlimited.

Note: The maximum number of connections depends on the number of free BULK PTERMs in the SOCKET line on the target (remote) system.

perm-conn-number

Defines the number of permanent connections that can exist between the host and the target systems.

perm-conn-number is a positive number between 0 and 65535. The default value is 0, indicating that permanent connections are not needed. In this case, the connections are always established dynamically when a new DDS request arrives.

BULK PTERM Parameters

TYPE is BULK

Specifies that the type of terminal is BULK.

Notes for LISTENER PTERMS Only

Parameters stack-ip-name, stack-ip-address, and stack-host-name are mutually exclusive. Specifying any of these parameters only makes sense in a multi-homed environment.

If one of these parameters is specified:

If none of these parameters are specified, the generic listener processes connection requests from the default TCP/IP stack.

Note: For more information about TCP/IP and SOCKET programming, see the CA IDMS Callable Services Guide. For more information about CA IDMS Server, see the CA IDMS Server r5 User Guide. For more information about the Services File and the Services Resolver, see the CA IDMS System Operations Guide.