138 lines
4.8 KiB
HTML
138 lines
4.8 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>Data Queues</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. -->
|
|
<!-- VT2A SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
|
<!-- RCHVMW2 on 5 Feb 1999 at 07:56:18 -->
|
|
<!-- File restructured for V5R2 -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<!-- Java sync-link -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2>Data Queues</h2>
|
|
|
|
<p>The i5/OS<SUP>(TM)</SUP> licensed program uses data queues to send data to the server
|
|
program. The server program also uses data queues for interprocess
|
|
communications with other iSeries<SUP>(TM)</SUP> applications and API calls.</p>
|
|
|
|
<p>The data queue must exist before your application uses the virtual terminal
|
|
APIs to open a path to a virtual terminal. See the
|
|
<a href="../rbam6/rbam6clmain.htm">Control Language (CL)</a> information for
|
|
details about creating and deleting data queues. See the <a href="QTVOPNVT.htm">Open
|
|
Virtual Terminal Path</a> (QTVOPNVT) API for information on how a server
|
|
program specifies the name of the data queue to be used.</p>
|
|
|
|
<p>The i5/OS licensed program communicates special events to the server
|
|
program using the data queue. The iSeries provides the information about the
|
|
special events using a data queue entry.</p>
|
|
|
|
<p>The following events result in data queue entries being sent:</p>
|
|
|
|
<ul>
|
|
<li>The virtual terminal receives data from an iSeries application</li>
|
|
|
|
<li>i5/OS closes the virtual terminal (This occurs when an iSeries
|
|
application's job is canceled.)</li>
|
|
</ul>
|
|
|
|
<p>The following table shows the structure of i5/OS data queue entries that
|
|
are sent to the data queue when an application uses the virtual terminal APIs.
|
|
All data queue entries have the same format.<br>
|
|
</p>
|
|
|
|
<table border>
|
|
<tr>
|
|
<th align="left" colspan="3"><em><a name="TBLENTRY">Format for i5/OS Data
|
|
Queue Entries</a></em></th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="left" valign="top">Name</th>
|
|
<th align="left" valign="top">Type</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">Entry Type</td>
|
|
<td align="left" valign="top" width="15%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="70%">Always set by i5/OS to *VRTTRM.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Entry ID</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Entry ID associated with entry. Valid values for
|
|
the 2 characters in this parameter are:
|
|
|
|
<ol type="1">
|
|
<li>The i5/OS operating system is closing (terminating) the session with the
|
|
virtual terminal. The server program should perform a close to indicate that
|
|
the server program is done using the virtual terminal.</li>
|
|
|
|
<li>An iSeries application has sent data to the virtual terminal. See
|
|
<a href="QTVRDVT.htm">Read from Virtual Terminal</a> (QTVRDVT) API for
|
|
information on how to read the data.
|
|
|
|
<p><strong>Note:</strong> All other values are reserved by the system.</p>
|
|
</li>
|
|
</ol>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">VTHandle</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">The virtual terminal handle associated with the
|
|
virtual terminal communications path previously opened by calling the Open
|
|
Virtual Terminal Path (QTVOPNVT) API. See <a href="QTVOPNVT.htm">Open Virtual
|
|
Terminal Path</a> (QTVOPNVT) API for additional details.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><br>
|
|
</td>
|
|
<td align="left" valign="top">CHAR(52)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Key</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Key value specified when the virtual terminal
|
|
communications path was opened. See <a href="QTVOPNVT.htm">Open Virtual
|
|
Terminal Path</a> (QTVOPNVT) API for additional details on specifying the key
|
|
value. The key value can be used for retrieving data queues by key.<br>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<hr>
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center">
|
|
<a href="#Top_Of_Page">Top</a> |
|
|
<a href="vt1a.htm">Virtual Terminal APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|