Sockets domain's specific gates
The specific gates provide access for other domains to functions that are provided by the SO domain.
- SOAD gate, ADD_REPLACE_TCPIPSERVICE function
The ADD_REPLACE_TCPIPSERVICE function is called at RDO time to install a TCPIPSERVICE resource. 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. - 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. - SOCK gate, ACCEPT function
Accept a new connection on a listening socket. - SOCK gate, BIND function
Bind a socket to an IP address and port number. - SOCK gate, CANCEL function
Cancel any outstanding asynchronous input or output on a socket. - SOCK gate, CLOSE function
The CLOSE function is called to close the socket connection to the TCP/IP client. - SOCK gate, CONNECT function
Connect a socket to another host and port. - SOCK gate, CREATE function
This function creates a new socket. - SOCK gate, ESTABLISH function
This function associates the calling task with the socket. - SOCK gate, GET_DATA_LENGTH function
Return the numbrr of bytes of data that can be read on the socket. - SOCK gate, GET_SOCKET_OPTS function
Return the attributes of a socket. - 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. - SOCK gate, RECEIVE function
The RECEIVE function receives a buffer of data from a TCP/IP connected client. - 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. - SOCK gate, RELINQUISH function
Relinquish a task's association with a persistent socket. - SOCK gate, RESERVE function
Reserve a task's association with a persistent socket. - SOCK gate, SCHEDULE_RECEIVER_TASK function
Schedule a new receiver task to be attached. - SOCK gate, SEND function
The SEND function sends a buffer of data to a connected TCP/IP client. - 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. - SOCK gate, SET_SOCKET_OPTS function
Set the attributes of a socket. - SOCK gate, SURRENDER function
This function requests the owner of a dormant session table entry (STE) to surrender control of it so that its resources can be used by another transaction. A dormant STE is one that is between transactions: it is waiting for another client interaction in a persistent connection. - SOCK gate, SWITCH_TO_SOCKET_TCB function
The SWITCH_TO_SOCKET_TCB function switches to the required socket TCB. - SOCK gate, SWITCH_FROM_SOCKET_TCB function
The SWITCH_FROM_SOCKET_TCB function switches from the socket TCB to the TCB that the SWITCH_TO_SOCKET_TCB was made from. - SOCK gate, SWITCH_FOR_ASYNC_IO function
The SWITCH_FOR_ASYNC_IO function switches from the required socket TCB so that an ASYNC I/O can be issued. - SOIS gate, DELETE_CERTIFICATE_DATA function
The DELETE_CERTIFICATE_DATA deletes certificate data from the sockets repository. - SOIS gate, EXPORT_CERTIFICATE_DATA function
The EXPORT_CERTIFICATE_DATA function saves a certificate in the sockets repository. - SOIS gate, IMPORT_CERTIFICATE_DATA function
The IMPORT_CERTIFICATE_DATA imports certificate data from the sockets repository. - 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. - 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. - SOIS gate, INQUIRE_CONNECTION function
Return information about a TCP/IP connection. - SOIS gate, INQUIRE_PARAMETERS function
Returns the current values of the parameters for the SO domain. The values might have changed from their initial values, as specified in the system initialization parameters. - SOIS gate, INQUIRE_SOCKET_TOKEN function
Return the socket token for the current task. - SOIS gate, INQUIRE_STATISTICS function
The INQUIRE_STATISTICS function returns gathered statistics about an open tcpipservice. - 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. - SOIS gate, SET_PARAMETERS function
The SET_PARAMETERS function is called during CICS initialization when the SIT is processed. It sets the startup parameters for the SO domain. - SOIS gate, VALIDATE_CIPHERS function
This function accepts a string of cipher suites and removes any that are not supported. - 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. - SOLS gate, LISTEN function
This function listens for incoming connections. The ports to listen on are controlled by installing and opening TCPIPSERVICE definitions. The function is called from the system task CSOL that is attached by the socket domain at startup. It returns when TCP/IP is closed or CICS shuts down. - SOPL gate, CREATE_SOCKET_POOL function
The CREATE_SOCKET_POOL function creates a pool to hold opened client HTTP connections in a dormant state for connection pooling. - SOPL gate, INQUIRE_SOCKET_POOL function
The INQUIRE_SOCKET_POOL function inquires on a pool of opened client HTTP connections that CICS is holding in a dormant state for connection pooling. - SOPL gate, DELETE_SOCKET_POOL function
The DELETE_SOCKET_POOL function deletes a pool of opened client HTTP connections that CICS is holding in a dormant state for connection pooling. - SOPL gate, GET_SOCKET_FROM_POOL function
The GET_SOCKET_FROM_POOL function retrieves an opened client HTTP connection from a pool to supply to a task. - SOPL gate, RETURN_SOCKET_TO_POOL function
The RETURN_SOCKET_TO_POOL function returns an opened client HTTP connection to a pool. - SOPL gate, CLOSE_SOCKET_IN_POOL function
The CLOSE_SOCKET_IN_POOL function closes and removes an opened client HTTP connection that is being held in a dormant state in a pool. - SOPL gate, RECLAIM_SOCKET function
The RECLAIM_SOCKET function is used when the CICS region is at its MAXSOCKETS limit, to free sockets that are being used for client HTTP connections held in a dormant state in a pool. - SOPL gate, INQUIRE_STATISTICS function
The INQUIRE_STATISTICS function returns gathered statistics about a pool of opened client HTTP connections. - 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. - SORD gate, IMMCLOSE function
The IMMCLOSE function is called to immediately close a TCP/IP service. The listener task closes the listening socket and no more connections to the port are permitted. All existing connections are closed and any tasks handling them are abnormally ended. - SORD gate, REGISTER function
The REGISTER function is called to open a TCP/IP service. It registers all the parameters of the service with the listener task. - SORD gate, REGISTER_NOTIFICATION function
This function is called by a client domain of the SO domain. After the registration call returns, the client domains SOCB notify gate may be driven asynchronously at any time a new TCP/IP connection arrives for a TCPIPSERVICE which has the PROTOCOL parameter set to the same as that registered by this call. - SORL gate, UPDATE_REVOCATION_LIST function
Update a certificate revocation list (CRL) in the LDAP server that is specified in the CRLPROFILE system initialization parameter. - SOTB gate, END_BROWSE function
The END_BROWSE function is called by CEMT and the SPI to end browsing tcpipservices. - SOTB gate, GET_NEXT function
The GET_NEXT function is called by CEMT and the SPI for browsing TCPIPSERVICE resources. It returns information about an installed TCPIPSERVICE resources. - SOTB gate, INQUIRE_TCPIPSERVICE function
The INQUIRE_TCPIPSERVICE function is called by CEMT and the SPI to inquire on a TCPIPSERVICE resource. It returns information about an installed TCPIPSERVICE resource. - SOTB gate, SET_TCPIPSERVICE function
The SET_TCPIPSERVICE function is called by CEMT and the SPI to set tcpipservice parameters. - SOTB gate, START_BROWSE function
The START_BROWSE function is called by CEMT and the SPI for an browsing tcpipservices.
dfhs3_SOspecificGates.html |
Last updated: Monday, 5 June 2017