SOCK gate, CONNECT function
Connect a socket to another host and port.
Input Parameters
- SWITCH_TCB
- Optional parameter
- Specifies if a switch to a socket TCB is required.
- Values of the parameter are:
- NO
- YES
- SOCKET_TOKEN
- A token that is generated when a socket is created, and is used subsequently to identify the socket.
- CERTIFICATE_LABEL
- Optional Parameter
- The label of an X.509 certificate that is used during the SSL handshake for the connection.
- CIPHER_COUNT
- Optional Parameter
- The number of cipher suites encoded in the CIPHER_SUITES parameter.
- CIPHER_SUITES
- Optional Parameter
- A string of up to 56 hexadecimal digits that encodes a list of up to 28 2-digit cipher suite codes.
- IP_ADDRESS
- Optional Parameter
- The binary IP address of the target.
- PORT
- Optional Parameter
- The binary port number of the target.
- SSL
- Optional Parameter
- A binary parameter that specifies whether the socket supports the secure sockets layer (SSL).
- Values for the parameter are:
- NO
- YES
- MINIMUM_DATA_LENGTH
- Optional Parameter
- The minimum amount of data that must be received before the request is considered to be complete.
- STRING_PORT
- Optional Parameter
- The port number of the target, expressed as a string.
- TIMEOUT_VALUE
- Optional Parameter
- The interval after which a request will time out.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- LOCK_FAILURE
- LOOP
- SOCKET_IN_USE
- The following values are returned when RESPONSE is EXCEPTION:
- ADDRESS_IN_USE
- ADDRESS_NOT_AVAILABLE
- ALREADY_ASSOCIATED
- CLIENT_ERROR
- CONNECTION_CLOSED
- CONNECTION_REFUSED
- INSUFFICIENT_STORAGE
- INSUFFICIENT_THREADS
- INVALID_OPTION
- IO_ERROR
- MISSING_OPTION
- NEVER_ASSOCIATED
- NO_CONNECTION
- NO_SOCKET_AVAILABLE
- NOT_AUTHORIZED
- NOT_PENDING
- NOTIFICATION_UNAVAILABLE
- NOTIFIED
- SCHEDULED
- SSL_HANDSHAKE_ERROR
- STATE_ERROR
- TCP_NOT_ACTIVE
- UNKNOWN_SESSION_TOKEN
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
- The following values are returned when RESPONSE is PURGED:
- TASK_CANCELLED
- TIMED_OUT
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.