SOIS gate, INQUIRE_CONNECTION function

Return information about a TCP/IP connection.

Input Parameters

CLIENT_HOSTNAME
Optional Parameter
A buffer in which the full host name of the client is returned to the caller.
SERVER_HOSTNAME
Optional Parameter
A buffer in which the full host name of the CICS region is returned to the caller.
SOCKET_TOKEN
The token that represents the connection.

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.
APPLDATA
Optional Parameter
The application data associated with the request.
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 binary IP address of the client.
CLIENT_BIN_PORT
Optional Parameter
The binary port number of the client.
CLIENT_IP_ADDRESS
Optional Parameter
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.
CLIENT_PORT
Optional Parameter
The port number of the client.
CLIENTLOC
Optional Parameter
The cluster connection type.
MVSIMAGE
Optional Parameter
The MVS image associated with the request.
SERVAUTH
Optional Parameter
The RACF SERVAUTH profile associated with the request.
SERVER_BIN_IP_ADDRESS
Optional Parameter
The binary IP address of the server.
SERVER_BIN_PORT
Optional Parameter
The binary port number of the server.
SERVER_IP_ADDRESS
Optional Parameter
The IP address of the server.
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.
SERVER_PORT
Optional Parameter
The port number of the server.
TCPIP_JOBNAME
Optional Parameter
The name of the TCP/IP job associated with the request.
TCPIP_ZONENAME
Optional Parameter
The name of the TCP/IP network security zone associated with the request.


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