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.
Input Parameters
- BACKLOG
- The value of the backlog parameter for the TCP/IP listen function for the current TCPIPSERVICE. It specifies how many connection requests TCP/IP will queue for the service.
- SOCKET_TOKEN
- A token that is generated when a socket is created, and is used subsequently to identify the socket.
- 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.