SOCK gate, GET_DATA_LENGTH function

Return the numbrr of bytes of data that can be read on the socket.

Input Parameters

SOCKET_TOKEN
A token that is generated when a socket is created, and is used subsequently to identify the socket.

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
BYTES_AVAILABLE
The number of bytes of data that are available to be read.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_SOCKget_data_length.html | Timestamp icon Last updated: Monday, 5 June 2017