SORD gate, REGISTER function

The REGISTER function is called to open a TCP/IP service. It registers all the parameters of the service with the listener task.

Input Parameters

AUTHENTICATION
Optional Parameter
The authentication and identification scheme to be used for inbound TCP/IP connections.
Values for the parameter are:
  • AUTOMATIC
  • AUTOREGISTER
  • BASIC
  • CERTIFICATE
  • KERBEROS
  • NONE
BACKLOG
Optional Parameter
The value of the backlog parameter passed to the TCP/IP listen function for this service. It specifies how many connection requests TCP/IP will queue for this service.
IPADDRESS
The specific IP address that the listener will bind to for this service.
PORT_NUMBER
The TCP/IP port number on which to listen for a new connection.
RECV_TIMEOUT
Specifies whether or not receives should timeout, and if so, after how long.
SERVICE_NAME
The name of the TCP/IP service.
SSL
Specifies whether or not connections to this service are to be secured using the Secure Sockets Layer protocols.
Values for the parameter are:
  • CLIENTAUTH
  • NO
  • YES
  • ATTLSAWARE
TRANID
The transaction ID that is to be attached when a new connection is made to the listening port.
URM
The name of a user-replacable program that the handler transaction for this service will invoke during request processing.
ATTACHSEC
Optional Parameter
The level of attach-time user security specified in the TCPIPSERVICE definition.
CERTIFICATE_LABEL
Optional Parameter
The name of a certificate within the keyfile that this service will use to authenticate itself to clients with, if the SSL protocol is used.
CIPHER_COUNT
Optional Parameter
The number of cipher suites encoded in the CIPHER_SUITES parameter.
CIPHER_SUITES
Optional Parameter
A binary representation of the cipher suites that are used to encrypt data.
DNSGROUPNAME
Optional Parameter
The group name with which CICS registers to Workload Manager, for connection optimization.
DNSGRPCRITICAL
Optional Parameter
A binary value indicating whether the service is a critical member of the DNS group. When a critical service closes or fails, CICS deregisters the group name from Workload Manager.
Values for the parameter are:
  • CRITICAL
  • NONCRITICAL
MAXDATA_LENGTH
Optional Parameter
The maximum length of data that CICS® will receive when operating as an HTTP server.
MAXPERSIST
Optional Parameter
The maximum number of persistent connections from web clients that the CICS region allows for this port at any one time.
PRIVACY
Optional Parameter
The level of SSL encryption required for inbound connections to this service.
Values for the parameter are:
  • NOTSUPPORTED
  • REQUIRED
  • SUPPORTED
PROTOCOL
Optional Parameter
The application level protocol used on the TCP/IP port.
Values for the parameter are:
  • ECI
  • HTTP
  • USER

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • LOCK_FAILURE
  • LOOP
  • UNKNOWN_POST_CODE
The following values are returned when RESPONSE is EXCEPTION:
  • AT_MAXSOCKETS
  • INSUFFICIENT_STORAGE
  • NOT_PERMITTED_TO_BIND
  • PORT_IN_USE
  • TCPIP_CLOSED
  • TCPIP_INACTIVE
  • TCPIP_SERVICE_ERROR
  • UNKNOWN_ADDRESS
  • UNKNOWN_LISTEN_TOKEN
The following values are returned when RESPONSE is INVALID:
  • INVALID_FORMAT
  • INVALID_FUNCTION
LISTEN_TOKEN
A token representing the opened TCP/IP service. This is subsequently used to close the service.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_SORDregister.html | Timestamp icon Last updated: Monday, 5 June 2017