328 lines
10 KiB
HTML
328 lines
10 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Receive Control (QzdmReceiveControl) API</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- COMM4 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB at -->
|
|
<!-- RCHVMW2 on 1 Jun 1999 at 17:32:50 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited December, 2001 =========================================== -->
|
|
<!--End Header Records ============================================== -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link ================================================= -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>Receive Control (QzdmReceiveControl) API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Receiver variable</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Format name of receiver variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Request variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Length of request variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Format name of request variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Library Name / Service Program: QSOC/QZDMMDTA<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *EXCLUDE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Receive Control (QzdmReceiveControl) API is used to receive a control message on an OptiConnect stream.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<br>
|
|
<h3>Restrictions</h3>
|
|
|
|
<p>The following restrictions apply:</p>
|
|
|
|
<ul>
|
|
<li>The OptiConnect QSOC subsystem must be started on both the local and remote systems prior to calling this API.<br><br></li>
|
|
|
|
<li>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.<br><br></li>
|
|
|
|
<li>A path must be opened to the remote system by using the Open Path (QzdmOpenPath) API prior to calling this API.</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Service Program Authority</em></dt>
|
|
<dd>*EXECUTE</dd>
|
|
</dl>
|
|
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The receiver variable that is to receive the output control information from the Receive Control (QzdmReceiveControl) API.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>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.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name of receiver variable</strong></dt>
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>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 <a href="#HDRRCRC100">RCRC0100 Format</a> for more information on the RCRC0100 format.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Request variable</strong></dt>
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The request variable structure that describes the input for the Receive Control (QzdmReceiveControl) API.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of request variable</strong></dt>
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>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.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name of request variable</strong></dt>
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>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 <a href="#HDRRCRQ100">RCRQ0100 Format</a> for more information on the RCRQ0100 format.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3><a name="HDRRCRC100">RCRC0100 Format</a></h3>
|
|
|
|
<p>The following table defines the information returned for Format RCRC0100.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="60%">Control message type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="20%">CHAR(8)</td>
|
|
<td align="left" valign="top" width="60%">Control message data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br><br>
|
|
<h3><a name="HDRRCRQ100">RCRQ0100 Format</a></h3>
|
|
|
|
<p>The following table defines the information required for Format RCRQ0100.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(16)</td>
|
|
<td align="left" valign="top" width="60%">Stream identifier</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br><br>
|
|
<h3><a name="HDRRCTLFLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Control message data.</strong> 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.</p>
|
|
|
|
<p><strong>Control message type.</strong> The type of control message to be received. This field is provided as output on the Receive Control (QzdmReceiveControl) API.</p>
|
|
|
|
<p>The possible value follows:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td valign="top">Close path message</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Stream identifier.</strong> The OptiConnect stream that is used for communications. This field is provided as output with the Open Stream (QzdmOpenStream) API.</p>
|
|
|
|
<br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C1D E</td>
|
|
<td valign="top">Length specified in parameter &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td valign="top">Program or service program &1 in library &2 ended. Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFADF0 E</td>
|
|
<td valign="top">The OptiConnect QSOC subsystem must be active.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFADF1 E</td>
|
|
<td valign="top">OptiConnect communication error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFADF4 E</td>
|
|
<td valign="top">OptiConnect detected sequence error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFADF5 E</td>
|
|
<td valign="top">OptiConnect API internal error, function code &1, return code &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFADF6 E</td>
|
|
<td valign="top">Request variable not valid, reason code &1.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<hr>
|
|
API introduced: V3R7
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> |
|
|
<a href="comm.htm">Communications APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|