SOIS gate, SET function
The SET function is called to open, close or immediately close the SO domain within a region. This is called in response to a SET TCPIP operator or SPI command.
Input Parameters
- ATTACHSEC
- Optional Parameter
- The level of attach-time user security required for this connection
- Values for the parameter are:
- LOCAL
- VERIFY
- MAXSOCKETS
- Optional Parameter
- The maximum number of IP sockets that can be managed by the CICS sockets domain. Used with TCPIP_STATUS(OPEN)
- TCPIP_STATUS
- Optional Parameter
- The intended status of the domain.
- Values for the parameter are:
- CLOSED
- IMMCLOSE
- OPEN
- TRACE_SUPPRESSION
- Optional Parameter
- A binary value indicating whether trace is to be suppressed.
- Values for the parameter are:
- NO
- YES
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.
- NEWMAXSOCKETS
- Optional Parameter
- The actual value of MAXSOCKETS. If the userid under which the CICS job is running does not have superuser authority, CICS might set the MAXSOCKETS limit to a smaller value than requested.