Send Response (QzdmSendResponse) API

The Send Response (QzdmSendResponse) API is used to send an acknowledgement and the response data over an OptiConnect path. A maximum of 32KB of data may be transferred in a single send response.

Restrictions

The following restrictions apply:

• The OptiConnect QSOC subsystem must be started on both the local and remote systems prior to calling this API.
  
  
• A stream must be opened to the OptiConnect device driver on the local system by using the Open Stream (QzdmOpenStream) API prior to calling this API.
  
  
• A path must be opened to the remote system by using the Open Path (QzdmOpenPath) API prior to calling this API.
  
  
• If the receiving system does not provide a large enough data buffer to receive all of the data, the data that will fit into the data buffer is moved, but the remaining data is truncated. The user must increase the size of the data buffer and then retry the entire transaction.
  
  
• A maximum of 16 transactions may be in progress for a stream-identifier and path-identifier pair.

Authorities and Locks

Service Program Authority

*EXECUTE

Required Parameter Group

Request variable

INPUT; CHAR(*)

The request variable structure that describes the input for the Send Response (QzdmSendResponse) API.

Length of request variable

INPUT; BINARY(4)

The length of the request variable, in bytes. The length of the request variable must be at least equal to the length of the input format, and less than or equal to the maximum length of 4KB.

Format name of request variable

INPUT; CHAR(8)

The format of the information that is provided as input for the Send Response (QzdmSendResponse) API. The SRSP0100 format is used by this API for the request variable. See SRSP0100 Format for more information on the SRSP0100 format.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

SRSP0100 Format

The following table defines the information required for Format SRSP0100.

Field Descriptions

Acknowledgement data. The acknowledgement data for the request. This field is provided as output on the Receive Response (QzdmReceiveResponse) API and indicates the acknowledgement data.

Actual response data length. The actual length that is sent for the response data. If the response data that is sent is larger than the buffer that is provided on the Send Request (QzdmSendRequest) API, not all of the data is sent. It is the responsibility of the user's application program to retry the entire transaction by using a larger data buffer size for the Send Request (QzdmSendRequest) API to receive all of the data with the Receive Response (QzdmReceiveResponse) API.

Data buffer length. The length of the data buffer that is used for sending data.

Data buffer pointer. The pointer to the data buffer that is used for sending data.

Number of input descriptors. The number of input descriptors that are used. An input descriptor describes where the input data may be found. The input descriptor consists of a space pointer to a data buffer and the length of the data buffer. A maximum of three input descriptors may be specified.

Offset to input descriptors. The offset to the input descriptors.

Reserved. A reserved space for the purpose of aligning pointer values on a 16-byte boundary. This field must be initialized to binary 0.

Stream identifier. The OptiConnect stream that is used for communications. This field is provided as output on the Open Stream (QzdmOpenStream) API.

Transaction identifier. The specific transaction associated with this Send Response (QzdmSendResponse) API. This field is provided as output on the Receive Request (QzdmReceiveRequest) API.

Error Messages