| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name of receiver variable | Input | Char(8) |
| 4 | Request variable | Input | Char(*) |
| 5 | Length of request variable | Input | Binary(4) |
| 6 | Format name of request variable | Input | Char(8) |
| 7 | Error code | I/O | Char(*) |
The Receive Control (QzdmReceiveControl) API is used to receive a control message on an OptiConnect stream.
When the Close Path (QzdmClosePath) API is issued on a system to close a path, the system that is at the other end of the path must issue the Receive Control (QzdmReceiveControl) API to complete the close path sequence. If the Receive Control (QzdmReceiveControl) API is not issued, the stream identifier that is associated with the path that is being closed is not available for subsequent communications until the control message is received.
The following restrictions apply:
The receiver variable that is to receive the output control information from the Receive Control (QzdmReceiveControl) API.
The length of the receiver variable, in bytes. The length of the receiver variable must be at least equal to or greater than the length of the output format.
The format of the information that is returned from Receive Control(QzdmReceiveControl) API. The RCRC0100 format is used by this API for the receiver variable. See RCRC0100 Format for more information on the RCRC0100 format.
The request variable structure that describes the input for the Receive Control (QzdmReceiveControl) API.
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.
The format of the information that is provided as input for the Receive Control (QzdmReceiveControl) API. The RCRQ0100 format is used by this API for the request variable. See RCRQ0100 Format for more information on the RCRQ0100 format.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table defines the information returned for Format RCRC0100.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Control message type |
| 1 | 1 | CHAR(8) | Control message data |
The following table defines the information required for Format RCRQ0100.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(16) | Stream identifier |
Control message data. The control message data returned for the control message type. For example, the control message data for the close path message contains the path identifier of the path that is being closed.
Control message type. The type of control message to be received. This field is provided as output on the Receive Control (QzdmReceiveControl) API.
The possible value follows:
| 1 | Close path message |
Stream identifier. The OptiConnect stream that is used for communications. This field is provided as output with the Open Stream (QzdmOpenStream) API.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFADF0 E | The OptiConnect QSOC subsystem must be active. |
| CPFADF1 E | OptiConnect communication error. |
| CPFADF4 E | OptiConnect detected sequence error. |
| CPFADF5 E | OptiConnect API internal error, function code &1, return code &2. |
| CPFADF6 E | Request variable not valid, reason code &1. |