SOIS gate, VERIFY_IP_ADDRESS function

This function verifies the format and value of an IP address, returning if required its char(16) value. It will return UNKNOWN_SERVER_ADDRESS is the input is not a correct IPv4 or IPv6 address format.

Input Parameters

SWITCH_TCB
Optional parameter
Specifies if a switch to a socket TCB is required.
Values of the parameter are:
  • NO
  • YES
SERVER_HOSTNAME
Optional Parameter
The host name of the target IP address.
SERVER_IP_ADDRESS
Optional Parameter
The target IP address.

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.
SERVER_BIN_IP_ADDRESS
The binary form of the IP address.


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