RZSO gate, CREATE function
Create a RequestStream and return a (local region) source RequestStream token for it.
The target process(or) is identified either by USERID and TRANID or by HOST_IP_ADDRESS and PORT_NUMBER. Precisely one of these groups must be provided. (The HOST_IP_ADDRESS is a character string as expected by the internal sockets domain interfaces.)
The SERVER_DATA may be retrieved at the target (RZTA) interface and is copied (and fixed) on this call.
The response is (exception, service_not_available) if it is not possible to resolve the target, or to set up a connection to the target. (Success does not guarantee that this exception will not occur on the SEND function.)
The response is (exception, target_unknown) if the HOST_IP_ADDRESS character string is malformed (as detected by the sockets domain interfaces). The response is invalid when the parameters are badly formed, in particular if there is not the correct combination of target identification parameters.
Input Parameters
- CERTIFICATE_LABEL
- Optional Parameter
- The label of an X.509 certificate that is used during the SSL handshake
- CIPHER_COUNT
- Optional Parameter
- The number of cipher suites encoded in the CIPHER_SUITES parameter.
- CIPHER_SUITES
- Optional Parameter
- A binary representation of the cipher suites used to encrypt data.
- DEBUG_BLOCK
- Optional Parameter
- A block used to return debugging information.
- HOST_IP_ADDRESS
- Optional Parameter
- Identification of the target which is to process the requests.
- PORT_NUMBER
- Optional Parameter
- Further identification of the target.
- PRIVACY
- Optional Parameter
- Specifies the level of SSL encryption required.
- Values for the parameter are:
- NOTSUPPORTED
- REQUIRED
- SUPPORTED
- SERVER_BLOCK
- Optional Parameter
- Data associated with the RequestStream available at the target end by the server using the RZTA interface.
- SSL_REQUIRED
- Optional Parameter
- Whether to use SSL on a socket transport. Otherwise ignored.
- Values for the parameter are:
- NO
- YES
- TRANID
- Optional Parameter
- TranId of the transaction which runs the target processor.
- USER_KEY_VERSION
- Optional Parameter
- USERID
- Optional Parameter
- Userid under which the requests are to be processed.
Output Parameters
- REASON
- The values for the parameter are:
- SERVICE_NOT_AVAILABLE
- TARGET_UNKNOWN
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- RS_TOKEN
- Token by which RequestStream is identified on all subsequent requests from this task on this region.
- APPLID
- Optional Parameter
- The application ID of the target processor.