SOIS gate, INQUIRE function

The INQUIRE function is called by tasks that have been attached by the listener in response to a new TCP/IP connection. It provides TCP/IP and socket information about the connection and the connected client.

Input Parameters

CLIENT_CERTIFICATE
Optional Parameter
A buffer in which the X.509 certificate presented by the client is returned to the caller.
CLIENT_HOSTNAME
Optional Parameter
A buffer in which the full host name of the client is returned to the caller.
GENERIC_HOSTNAME
Optional Parameter
A buffer in which the full generic host name of the CICS® region, as known to the DNS in a connection optimization environment, is returned to the caller.
KERBEROS_PRINCIPAL
Optional Parameter
The principal for Kerberos authentication.
LISTEN_TOKEN
Optional Parameter
A token representing the opened TCP/IP service.
LOCKHELD
Optional Parameter
Specifies whether the caller already holds the lock for searching the LTE chain.
Values for the parameter are:
  • NO
  • YES
REALM
Optional Parameter
The realm name under which the CICS region is running.
SERVER_HOSTNAME
Optional Parameter
A buffer in which the full host name of the CICS region is returned to the caller.
SOCKET_ADDR
Optional Parameter
The address of the socket.
SOCKET_TOKEN
Optional Parameter
A token that represents the socket.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • CEEPIPI_ERROR
  • LISTENER_ATTACH_FAILURE
  • LOCK_FAILURE
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • AT_MAXSOCKETS
  • HOSTNAME_TRUNCATED
  • IIOPLISTENER_NO
  • IO_ERROR
  • MAXSOCKETS_HARD_LIMIT
  • REPOSITORY_ERROR
  • TCPIP_ALREADY_CLOSED
  • TCPIP_ALREADY_OPEN
  • TCPIP_UNAVAILABLE
  • UNKNOWN_CLIENT_ADDRESS
  • UNKNOWN_CLIENT_HOSTNAME
  • UNKNOWN_LISTEN_TOKEN
  • UNKNOWN_SERVER_ADDRESS
  • UNKNOWN_SERVER_HOSTNAME
  • UNKNOWN_SESSION_TOKEN
  • UNKNOWN_SOCKET_TOKEN
The following values are returned when RESPONSE is INVALID:
  • INVALID_FORMAT
  • INVALID_FUNCTION
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
ACTSOCKETS
Optional Parameter
The number of sockets that are currently active.
ATTACHSEC
Optional Parameter
The level of attach-time user security specified in the TCPIPSERVICE definition.
Values for the parameter are:
  • LOCAL
  • VERIFY
AUTHENTICATION
Optional Parameter
The authentication and identification scheme that is used for the connection.
Values for the parameter are:
  • ASSERTED
  • AUTOMATIC
  • AUTOREGISTER
  • BASIC
  • CERTIFICATE
  • KERBEROS
  • NONE
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
CERTIFICATE_STATUS
Optional Parameter
The status of the X.509 certificate associated with the connection.
Values for the parameter are:
  • NONE
  • REGISTERED
  • UNREGISTERED
  • UNTRUSTED
  • UNKNOWN
CERTIFICATE_USERID
Optional Parameter
The user ID associated with the certificate.
CIPHER_SELECTED
Optional Parameter
The code for the cipher suite that was selected for use during the SSL connection.
CLIENT_BIN_IP_ADDRESS
Optional Parameter
The 32-bit binary IP address of the client.
CLIENT_IP_ADDRESS
Optional Parameter
The text representation of the IP address of the client.
CLIENT_IP_ADDRESS_LEN
Optional Parameter
The length of the text representation of the client IP address.
CLIENT_IPFAMILY
Optional Parameter
The format of the client IP address.
CONNECTION_SECURE
Optional Parameter
Whether the connection is SSL secured.
Values for the parameter are:
  • YES
  • NO
CONNECTIONS
Optional Parameter
Either the number of connections for the service represented by the supplied TCPIPSERVICE name, or the total number of TCP/IP connections to all of the currently active services.
DNS_STATUS
Optional Parameter
The Domain Name System (DNS) registration status of the service.
Values for the parameter are:
  • DEREGERROR
  • DEREGISTERED
  • NOTAPPLIC
  • REGERROR
  • REGISTERED
  • UNAVAILABLE
  • UNREGISTERED
FORCE_CLOSE
Optional Parameter
Specifies whether the socket must be closed after the client has received a response (YES), or whether the socket remains open to allow the client to maintain a persistent connection (NO).
Values for the parameter are:
  • YES
  • NO
GROUP_NAME
Optional Parameter
The name of the dynamic DNS group that is registered with the MVS™ Work Load Manager for this service.
LISTENER_PORT
Optional Parameter
The port number that the connection was received on.
LISTENER_STATUS
Optional Parameter
The current status of the SO domain listener task.
Values for the parameter are:
  • CLOSED
  • CLOSING
  • IMMCLOSE
  • IMMCLOSING
  • OPEN
  • OPENING
MAXDATA_LENGTH
Optional Parameter
The maximum length of data that CICS will receive when operating as an HTTP server.
MAXSOCKETS
Optional Parameter
The value of the MAXSOCKETS system initialization parameter.
PEER_BIN_IP_ADDRESS
Optional Parameter
The binary IP address of the peer client or server.
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
SERVER_BIN_IP_ADDRESS
Optional Parameter
The 32-bit binary IP address of the CICS region.
SERVER_IP_ADDRESS
Optional Parameter
The text representation of the IP address of the CICS region.
SERVER_IP_ADDRESS_LEN
Optional Parameter
The length of the text representation of the server IP address.
SERVER_IPFAMILY
Optional Parameter
The format of the server IP address.
SSLTYPE
Optional Parameter
Specifies whether or not SSL is being used to secure this connection.
Values for the parameter are:
  • CLIENTAUTH
  • NO
  • YES
  • ATTLSAWARE
TCPIP_STATUS
Optional Parameter
The status of TCP/IP in the CICS region.
Values for the parameter are:
  • CLOSED
  • CLOSING
  • IMMCLOSE
  • IMMCLOSING
  • OPEN
  • OPENING
TCPIPSERVICE_NAME
Optional Parameter
The name of the service that attached the task.
TRANSID
Optional Parameter
The transaction ID associated with the service.
TSQ_PREFIX
Optional Parameter
The temporary storage queue prefix specified in the TCPIPSERVICE resource for this connection.
URM_NAME
Optional Parameter
The name of the user-replaceable program specified in the TCPIPSERVICE resource for this connection.
USER_TOKEN
Optional Parameter
The user token associated with the connection.
VALIDATION_HASH
Optional Parameter


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