Socket domain’s specific gates

Table 100 summarizes the socket domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gate, the functions provided by the gate, and whether or not the functions are available through the exit programming interface (XPI).

Table 100. Socket domain’s specific gates
Gate Trace Function XPI
SOCK
SO 0201
SO 0202
SEND
SEND_SSL_DATA
RECEIVE
RECEIVE_SSL_DATA
CLOSE
LISTEN
NO
NO
NO
NO
NO
NO
SORD
SO 0301
SO 0302
REGISTER
DEREGISTER
IMMCLOSE
NO
NO
NO
SOIS
SO 0401
SO 0402
SET_PARAMETERS
INITIALIZE_ENVIRONMENT
INQUIRE
SET
INQUIRE_STATISTICS
VERIFY
EXPORT_CERTIFICATE_DATA
IMPORT_CERTIFICATE_DATA
DELETE_CERTIFICATE_DATA
NO
NO
NO
NO
NO
NO
NO
NO
NO
SOAD
SO 0601
SO 0602
ADD_REPLACE_TCPIPSERVICE
DELETE_TCPIPSERVICE
NO
NO
SOTB
SO 0701
SO 0702
INQUIRE_TCPIPSERVICE
START_BROWSE
GET_NEXT
END_BROWSE
SET_TCPIPSERVICE
NO
NO
NO
NO
NO
SOSE
SO 0801
SO 0802
INITIALIZE_SSL
SECURE_SOC_INIT
SECURE_SOC_READ
SECURE_SOC_WRITE
SECURE_SOC_CLOSE
SECURE_SOC_RESET
TERMINATE_SSL
EXPORT_CERTIFICATE_DATA
IMPORT_CERTIFICATE_DATA
DELETE_CERTIFICATE_DATA
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO

SOCK gate, SEND function

The SEND function sends a buffer of data to a connected TCP/IP client.

Input parameters

SEND_BUFFER
is the buffer of data to be sent.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION, INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_SESSION_TOKEN
INSUFFICIENT_STORAGE
IO_ERROR,CONNECTION_CLOSED
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE
SOCKET_IN_USE

SOCK gate, SEND_SSL_DATA function

The SEND_SSL_DATA function is called to send data to a connected TCP/IP client if the connection is secured using SSL.

Input parameters

STE_PTR
is a pointer to the STE control block of the session.
SEND_BUFFER
is the buffer of data to be sent.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION, INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_SESSION_TOKEN
INSUFFICIENT_STORAGE
IO_ERROR,CONNECTION_CLOSED
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE
SOCKET_IN_USE

SOCK gate, RECEIVE function

The RECEIVE function receives a buffer of data from a TCP/IP connected client.

Input parameters

RECEIVE_BUFFER
is the buffer to receive the data into.
[TIMEOUT]
is an optional parameter. It can take two values:
DEFAULT|SOCKETCLOSE
If not specified or a value of SOCKETCLOSE is specified then the timeout is taken from the tcpipservice definition. If DEFAULT is specified then the timeout is 30 seconds.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION, INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_SESSION_TOKEN
INSUFFICIENT_STORAGE
IO_ERROR,CONNECTION_CLOSED
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE
SOCKET_IN_USE

SOCK gate, RECEIVE_SSL_DATA function

The RECEIVE_SSL_DATA function is called to receive data from a connected TCP/IP client if the connection is secured using SSL.

Input parameters

STE_PTR
is a pointer to the STE control block of the session.
RECEIVE_BUFFER
is the buffer to receive data into.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION, INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_SESSION_TOKEN
INSUFFICIENT_STORAGE
IO_ERROR,CONNECTION_CLOSED
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE
SOCKET_IN_USE

SOCK gate, CLOSE function

The CLOSE function is called to close the socket connection to the TCP/IP client.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION, INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_SESSION_TOKEN
INSUFFICIENT_STORAGE
IO_ERROR,CONNECTION_CLOSED
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE
SOCKET_IN_USE

SOCK gate, LISTEN function

The LISTEN function is the main routine for the SO domain listener task CSOL. When the listener task starts it branches into the LISTEN function of the SOCK gate. This allows the listener code to be written at the domain level rather than the task level.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SORD gate, REGISTER function

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

Input parameters

PORT_NUMBER
is the TCP/IP port number to listen for new connection on.
SERVICE_NAME
is the name of the tcpipservice.
TRANID
is the transaction ID that is to be attached when a new connection is made to the listening port.
SSL
specifies whether or not connections to this service are to be secured using the Secure Sockets Layer protcols.
BACKLOG
is 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.
URM
is the name of a user-replacable program that the handler transaction for this service will invoke during request processing.
TSQPREFIX
is the prefix for TS queues that are created by the programs handling requests for this service.
IPADDRESS
is the specific IP address that the listener will bind to for this service.
[CERTIFICATE_LABEL]
is 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.
RECV_TIMEOUT
specifies whether or not receives should timeout, and if so, after how long.

Output parameters

LISTEN_TOKEN
is a token representing the opened tcpipservice. This is subsequently used to close the service.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_LISTEN_TOKEN
INSUFFICIENT_STORAGE
NOT_PERMITTED_TO_BIND
TCPIP_SERVICE_ERROR
TCPIP_CLOSED
TCPIP_INACTIVE
UNKNOWN_ADDRESS
PORT_IN_USE
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SORD gate, DEREGISTER function

The DEREGISTER function is called to close a tcpipservice. The listener task closes the listening socket and no more connections to the port are permitted. Any tasks handling existing connections are allowed to end normally.

Input parameters

LISTEN_TOKEN
is a token representing the opened tcpipservice.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_LISTEN_TOKEN
INSUFFICIENT_STORAGE
NOT_PERMITTED_TO_BIND
TCPIP_SERVICE_ERROR
TCPIP_CLOSED
TCPIP_INACTIVE
UNKNOWN_ADDRESS,
PORT_IN_USE
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SORD gate, IMMCLOSE function

The IMMCLOSE function is called to immediatly close a tcpipservice. The listener task closes the listening socket and no more connections to the port are permitted. All existing connections are closes and any tasks handling them are abended.

Input parameters

LISTEN_TOKEN
is a token representing the opened tcpipservice.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_LISTEN_TOKEN
INSUFFICIENT_STORAGE
NOT_PERMITTED_TO_BIND
TCPIP_SERVICE_ERROR
TCPIP_CLOSED
TCPIP_INACTIVE
UNKNOWN_ADDRESS,
PORT_IN_USE
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, SET_PARAMETERS function

The SET_PARAMETERS function is called during CICS® initialisation when the SIT is processed. It sets the startup parameters for the SO domain.

Input parameters

TCPIP
is a YES or NO value indicating if the SO domain is to initalise in this CICS region.
SSLDELAY
is a the SSL timeout value.
SSLTCBS
specifies the number of S8 TCBs to be attached for SSL use.
ENCRYPTION
specifies the type of encryption that will be used by the system. The value can be NORMAL,STRONG or WEAK.
KEYFILE
specifies the name of the HFS keyring file that contains the keypairs and certificate data.
QUALIFIER
is actually the password that was used to secure the keyring file upon creation.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, INITIALIZE_ENVIRONMENT function

The INITIALIZE_ENVIRONMENT function is called during SO domain startup to create and initialize the CEEPIPI Language Environment pre-initialized environment for invokcation of C functions.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

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 connection and the connected client.

Input parameters

[LISTEN_TOKEN]
is a token representing an opened tcpipservice.
[CLIENT_HOSTNAME]
is a buffer in which the full hostname of the client is returned to the caller.
[SERVER_HOSTNAME]
is a buffer in which the full hostname of the CICS region is returned to the caller.
[GENERIC_HOSTNAME]
is a buffer in which the full generic hostname of the CICS region, as known to the DNS in a connection optimization environment, is returned to the caller.

Output parameters

[CLIENT_IP_ADDRESS]
is the text representation of the IP address of the client.
[CLIENT_BIN_IP_ADDRESS]
is the 32 bit binary IP address of the client.
[SERVER_IP_ADDRESS]
is the text representation of the IP address of the CICS region.
[SERVER_BIN_IP_ADDRESS]
is the 32 bit binary IP address of the CICS region.
[LISTENER_PORT]
is the port number that the connection was received on.
[CLIENT_IP_ADDRESS_LEN]
is the length of the text representation of the client IP address.
[SERVER_IP_ADDRESS_LEN]
is the length of the text representation of the server IP address.
[CERTFICATE_USERID]
is the userid associated with the certificate that was used to authenticate a client if this is an SSL connection.
[SSLTYPE]
returns whether or not SSL is being used to secure this connection.
[URM_NAME]
is the name of the user-replaceable program specified on the tcpipservice definition for this connection.
[TSQ_PREFIX]
is the TS queue prefix specified on the tcpipservice definition for this connection.
[LISTENER_STATUS]
is the current status of the SO domain listener task.
[CONNECTIONS]
is either the number of connections for the service represented by the supplied LISTEN_TOKEN, or the total number of TCP/IP connections to all of of the currently active services.
[TCPIPSERVICE_NAME]
is the name of the service that attached the task, or the name associated with the supplied LISTEN_TOKEN.
[GROUP_NAME]
is the name of the dynamic DNS group that is registered with the MVS™ Work Load Manager for this service.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, SET function

The SET function is called to open, close or immediatly close the SO domain within a region. This is called in response to a SET TCPIP operator or SPI command.

Input parameters

[TCPIP_STATUS]
is either OPEN,CLOSED or IMMCLOSE.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, INQUIRE_STATISTICS function

The INQUIRE_STATISTICS function returns gathered statistics about an open tcpipservice.

Input parameters

LISTEN_TOKEN
is the token representing the open tcpipservice, returned from the SORD REGISTER function.
RESET
is a value indicating if the statistics should be reset.

Output parameters

[ATTACH_COUNT]
is the total number of tasks that have been attached to handle incoming connections.
[PEAK_CONNECTIONS]
is the high water mark for connections since that last reset.
[SEND_COUND]
is the number of times TCP/IP send has been called.
[SEND_BYTES]
is the number of bytes that have been sent to TCP/IP.
[RECV_COUNT]
is the number of times TCP/IP receive has been called.
[RECV_BYTES]
is the number of bytes received from TCP/IP.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, VERIFY function

The VERIFY function checks an IP address string in the form nnn.nnn.nnn.nnn for validity and returns the binary form.

Input parameters

SERVER_IP_ADDRESS
is a char string in the form nnn.nnn.nnn.nnn representing an IP address.

Output parameters

SERVER_BIN_IP_ADDRESS
is the 32 bit binary number of the IP address.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, EXPORT_CERTIFICATE_DATA function

The EXPORT_CERTIFICATE_DATA function saves a certificate in the sockets repository.

Input parameters

CERTIFICATE_INFORMATION
is a block representing the certificate.

Output parameters

REPOSITORY_TOKEN
is a token that represents the saves certificate data.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, IMPORT_CERTIFICATE_DATA function

The IMPORT_CERTIFICATE_DATA imports certificate data from the sockets repository.

Input parameters

[REPOSITORY_TOKEN]
a token representing a certificate exported to the repository.
CERTIFICATE_INFORMATION
is the block representing the certificate. The data is returned by the function.

Output parameters

CERTIFICATE_USERID
is the userid associated with the certificate.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOIS gate, DELETE_CERTIFICATE_DATA function

The DELETE_CERTIFICATE_DATA deletes certificate data from the sockets repository.

Input parameters

REPOSITORY_TOKEN
a token representing a certificate exported to the repository.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOAD gate, ADD_REPLACE_TCPIPSERVICE function

The ADD_REPLACE_TCPIPSERVICE function is called at RDO time to install a tcpipservice definition. If the status is OPEN then the service is also opened using the SORD REGISTER function. A catalog entry is written to record the installed resource.

Input parameters

TCPIPSERVICE_NAME
is the name of the tcpipservice.
URM_NAME
is the name of the user-replaceable program.
STATUS
is either OPEN or CLOSED.
SSL
is either YES, NO or CLIENTAUTH.
TRANSACTION
is the tranid of the transaction to attach for each connection to this service.
BACKLOG
is the TCP/IP listen backlog parameter.
PORTNUMBER
is the port number to listen on.
[CERTIFICATE_LABEL]
is the name of the certificate from the keyfile to use to authenticate this service.
IPADDRESS
is the IP address to bind this service to.
TSQPREFIX
is the TS queue prefix to use for this service.
SOCKETCLOSE
is the value of receive timeout for this service.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOAD gate, DELETE_TCPIPSERVICE function

The DELETE_TCPIPSERVICE function is called at RDO time to remove an installed tcpipservice definition. If the status is OPEN then the tcpipservice is not removed. The catalog entry is removed for the discarded resource.

Input parameters

TCPIPSERVICE_NAME
is the name of the tcpipservice to remove.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOTB gate, INQUIRE_TCPIPSERVICE function

The INQUIRE_TCPIPSERVICE function is called by CEMT and the SPI for an INQUIRE TCPIPSERICE function. It returns information about an installed tcpipservice.

Input parameters

TCPIPSERVICE_NAME
is the name of the tcpipservice to inquire upon.

Output parameters

[TRANSID]
is the transaction ID associated with the service.
[URM]
is the name of the user-replaceable program associated with the service.
[PORT]
is the port number associated with the service.
[BACKLOG]
is the backlog value associated with the service.
[CONNECTIONS]
is the current number of connections associated with the service.
[IPADDRESS]
is the IP address that the service is bound to.
[TSQPREFIX]
is the TS queue prefix associated with the service.
[SOCKETCLOSE]
is the receive timeout value associated with the service.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOTB gate, START_BROWSE function

The START_BROWSE function is called by CEMT and the SPI for an browsing tcpipservices.

Output parameters

BROWSE_TOKEN
is a token representing the browse.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOTB gate, GET_NEXT function

The GET_NEXT function is called by CEMT and the SPI for browsing tcpipservices. It returns information about an installed tcpipservice.

Input parameters

BROWSE_TOKEN
is a token representing the browse.

Output parameters

TCPIPSERVICE_NAME
is the name of the tcpipserivce.
[TRANSID]
is the transaction ID associated with the service.
[URM]
is the name of the user-replaceable pogram associated with the service.
[PORT]
is the port number associated with the service.
[BACKLOG]
is the backlog value associated with the service.
[CONNECTIONS]
is the current number of connections associated with the service.
[IPADDRESS]
is the IP address that the service is bound to.
[TSQPREFIX]
is the TS queue prefix associated with the service.
[SOCKETCLOSE]
is the receive timeout value associated with the service.
[STATUS]
is the current status of the service:
OPEN|OPENING|CLOSED|CLOSING|IMMCLOSING
[SSL]
is the SSL setting for the service:
YES|NO|CLIAUTH
[CERTIFICATE_LABEL]
is the certificate label associated with the service.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOTB gate, END_BROWSE function

The END_BROWSE function is called by CEMT and the SPI to end browsing tcpipservices.

Input parameters

BROWSE_TOKEN
is a token representing the browse.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOTB gate, SET_TCPIPSERVICE function

The SET_TCPIPSERVICE function is called by CEMT and the SPI to set tcpipservice parameters.

Input parameters

TCPIPSERVICE_NAME
is the name of the service to set.
[STATUS]
is the status to set for the service:
OPEN|CLOSED|IMMCLOSED
[URM]
is the name of the user-replaceable program.
[BACKLOG]
is the value of the new backlog parameter. This can only be set if the service is closed.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOSE gate, INITIALIZE_SSL function

The INITIALIZE_SSL function is called at SO domain initialization. It creates the environment necessary to perform Secure Sockets Layer communication.

Output parameters

GSK_RETURN_CODE
is the return code from the System SSL component of OS/390® that CICS uses to perform SSL communications.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
CEEPIPI_ERROR
GSK_ERROR

SOSE gate, SECURE_SOC_INIT function

The SECURE_SOC_INIT function is called when a new connection is established with the service and SSL is enabled. This function performs the SSL handshake to establish the security.

Output parameters

GSK_RETURN_CODE
is the return code from the System SSL component of OS/390 that CICS uses to perform SSL communications.
CERTIFICATE
is the certificate used by the client to authenticate itself.
CERTIFICATE_USERID
is the userid associated with the client certificate.
CIPHERS_SELECTED
represents the encryption cyphers that have been selected in negotiation with the client and server.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
GSK_INACTIVE,INSUFFICIENT_THREADS
GETMAIN_FAILED,REPOSITORY_ERROR
CONNECTION_CLOSED,CLIENT_ERROR
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
CEEPIPI_ERROR
GSK_ERROR

SOSE gate, SECURE_SOC_READ function

The SECURE_SOC_READ function is called to read data on a secure connection.

Input parameters

RECEIVE_BUFFER
is the buffer to hold the received data.

Output parameters

GSK_RETURN_CODE
is the return code from the System SSL component of OS/390 that CICS uses to perform SSL communications.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
CEEPIPI_ERROR
GSK_ERROR
CONNECTION_CLOSED
HANDSHAKE_ERROR

SOSE gate, SECURE_SOC_WRITE function

The SECURE_SOC_WRITE function is called to send data on a secure connection.

Input parameters

SEND_BUFFER
is the buffer to holding the data to send.

Output parameters

GSK_RETURN_CODE
is the return code from the System SSL component of OS/390 that CICS uses to perform SSL communications.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
CEEPIPI_ERROR
GSK_ERROR
CONNECTION_CLOSED
HANDSHAKE_ERROR

SOSE gate, SECURE_SOC_CLOSE function

The SECURE_SOC_CLOSE function is called to close a secure connection.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
CEEPIPI_ERROR
GSK_ERROR

SOSE gate, SECURE_SOC_RESET function

The SECURE_SOC_RESET function is called to reset a secure connection.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
CEEPIPI_ERROR
GSK_ERROR

SOSE gate, TERMINATE_SSL function

The TERMINATE_SSL function is to terminate all SSL operation in a region.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
CEEPIPI_ERROR

SOSE gate, EXPORT_CERTIFICATE_DATA function

The EXPORT_CERTIFICATE_DATA function saves a certificate in the sockets repository.

Input parameters

CERTIFICATE_INFORMATION
is a block representing the certificate.

Output parameters

REPOSITORY_TOKEN
is a token that represents the saves certificate data.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOSE gate, IMPORT_CERTIFICATE_DATA function

The IMPORT_CERTIFICATE_DATA imports certificate data from the sockets repository.

Input parameters

[REPOSITORY_TOKEN]
a token representing a certificate exported to the repository.
CERTIFICATE_INFORMATION
is the block representing the certificate. The data is returned by the function.

Output parameters

CERTIFICATE_USERID
is the userid associated with the certificate.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE

SOSE gate, DELETE_CERTIFICATE_DATA function

The DELETE_CERTIFICATE_DATA deletes certificate data from the sockets repository.

Input parameters

REPOSITORY_TOKEN
a token representing a certificate exported to the repository.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|
KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_FORMAT
INVALID_FUNCTION
DISASTER
ABEND
LOOP
LOCK_FAILURE
[[ Contents Previous Page | Next Page Index ]]