1750 lines
48 KiB
HTML
1750 lines
48 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>List Network Connections (QtocLstNetCnn) 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. -->
|
|
<!-- Created for V5R1-->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- 050602 SGLEZ Add new V5R4 IPv6 fields -->
|
|
<!-- Edited by Sglez Jun 05 ========================================= -->
|
|
<!-- 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>List Network Connections (QtocLstNetCnn) 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%">Qualified user space name</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Format name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Connection list qualifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Connection list qualifier size</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Connection list qualifier format</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</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>
|
|
Service Program: QTOCNETSTS<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The List Network Connections
|
|
(QtocLstNetCnn) API returns a non-detailed list of all network connections, or
|
|
a subset of all network connections for a specified network connection type.
|
|
With each call to this API you can request IPv4 or IPv6 connections, but not
|
|
both at the same time.</p>
|
|
|
|
<p>TCP/IP must be active on this system; otherwise error message TCP84C0 will
|
|
be issued.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>User Space Library Authority</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>User Space Authority</em></dt>
|
|
|
|
<dd>*CHANGE</dd>
|
|
|
|
<dt><em>User Space Lock</em></dt>
|
|
|
|
<dd>*SHRNUP</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Qualified user space name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)<br>
|
|
<p>The user space that is to receive the created list. The first 10 characters
|
|
contain the user space name; the second 10 characters contain the name of the
|
|
library in which the user space is located. You can use these special values
|
|
for the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The library list</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)<br>
|
|
<p>The format of the space information to be returned. The format name
|
|
supported is:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCNN0100</em></td>
|
|
<td align="left" valign="top">Non-detailed list of selected TCP/IPv4 local
|
|
system connections. Refer to <a href="#NCNN0100">NCNN0100 Format</a> for
|
|
details on the format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCNN0200</em></td>
|
|
<td align="left" valign="top">Non-detailed list of selected TCP/IPv6 local
|
|
system connections. Refer to <a href="#NCNN0200">NCNN0200 Format</a> for
|
|
details on the format.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Connection list qualifier</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)<br>
|
|
<p>A restriction on the network connections to be listed.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Connection list qualifier size</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The size in bytes of the connection list qualifier parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Connection list qualifier format</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the connection list qualifier parameter. The format name
|
|
supported is:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCLQ0100</em></td>
|
|
<td align="left" valign="top">IPv4 connection list qualifier. Refer to <a href=
|
|
"#NCLQ0100">NCLQ0100 Format</a> for details on the format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCLQ0200</em></td>
|
|
<td align="left" valign="top">IPv6 connection list qualifier. Refer to <a href=
|
|
"#NCLQ0200">NCLQ0200 Format</a> for details on the format.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)<br>
|
|
<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="HDRSPCA0">Format of Connection Status Lists</a></h3>
|
|
|
|
<p>To request a non-detailed list of local system connections, use format
|
|
NCNN0100.</p>
|
|
<p>The connection description list consists of:</p>
|
|
|
|
<ul>
|
|
<li>A user area</li>
|
|
|
|
<li>A generic header</li>
|
|
|
|
<li>An input parameter section</li>
|
|
|
|
<li>A header section</li>
|
|
|
|
<li>A list data section:
|
|
|
|
<ul>
|
|
<li>NCNN0100 format, or</li>
|
|
|
|
<li>NCNN0200 format</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>For details about the user area and generic header, see <a href=
|
|
"../apiref/usf.htm">User Space Format for List APIs</a>. For details about the remaining
|
|
items, see the following sections.</p>
|
|
|
|
<p>When you retrieve list entry information from a user space, you must use the
|
|
entry size returned in the generic header. The size of each entry may be padded
|
|
at the end. If you do not use the entry size, the result may not be valid. For
|
|
examples of how to process lists, see API <a href=
|
|
"../apiref/apiexmp.htm">Examples</a>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRSPCA01">Input Parameter Section</a></h3>
|
|
|
|
<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(10)</td>
|
|
<td align="left" valign="top" width="60%">User space name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User space library name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Format name specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Connection list qualifier specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2" rowspan="2"><br>
|
|
</td>
|
|
<td>BINARY(4)</td>
|
|
<td>Connection list qualifier size specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>CHAR(8)</td>
|
|
<td>Connection list qualifier format specified</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRSPCA02">Header Section</a></h3>
|
|
|
|
<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(10)</td>
|
|
<td align="left" valign="top" width="60%">User space name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User space library name used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCLQ0100">NCLQ0100 Format</a></h3>
|
|
|
|
<p>The following table shows the format of the IPv4 connection list qualifier
|
|
input parameter, named the NCLQ0100 format. For detailed descriptions of the
|
|
fields in the table, see <a href="#NCLQ0100_FIELD">Field Descriptions</a>.</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(10)</td>
|
|
<td align="left" valign="top" width="60%">Net connection type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">List request type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(12)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local internet address lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local internet address upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote internet address lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote internet address upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">56</td>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="center" valign="top">3C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCLQ0100_FIELD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>List request type.</strong> The local internet address range, local
|
|
port range, remote internet address range, and remote port range for which
|
|
information is requested. Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All objects returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SUBSET</em></td>
|
|
<td align="left" valign="top">Restrict the objects returned in the list to a
|
|
specified subset.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local internet address lower value.</strong> The lower value of the
|
|
local system internet address range, in dotted decimal format, requested for
|
|
subsetting the list. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all local internet addresses.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local internet address upper value.</strong> The upper value of the
|
|
local system internet address range, in dotted decimal format, requested for
|
|
subsetting the list. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one local internet address specified
|
|
by the local internet address lower value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local port lower value.</strong> The lower value of the local system
|
|
port range requested for subsetting the list. Valid values range from 1 to
|
|
65535. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all local ports.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local port upper value.</strong> The upper value of the local system
|
|
port range requested for subsetting the list. Valid values range from 1 to
|
|
65535. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one local port specified in local
|
|
port lower value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Net connection type.</strong> The type of connection or socket.
|
|
Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All connection types</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*TCP</em></td>
|
|
<td align="left" valign="top">A transmission control protocol (TCP) connection
|
|
or socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*UDP</em></td>
|
|
<td align="left" valign="top">A User Datagram Protocol (UDP) socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*IPI</em></td>
|
|
<td align="left" valign="top">An Internet Protocol (IP) over Internetwork
|
|
Packet Exchange (IPX) connection or socket.
|
|
|
|
<p><strong>Note:</strong> As of V5R2,
|
|
IP over IPX is no longer supported.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*IPS</em></td>
|
|
<td align="left" valign="top">An Internet Protocol (IP) over SNA connection or
|
|
socket.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote internet address lower value.</strong> The lower value of the
|
|
remote system internet address range, in dotted decimal format, requested for
|
|
subsetting the list. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all remote internet addresses.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote internet address upper value.</strong> The upper value of the
|
|
remote system internet address range, in dotted decimal format, requested for
|
|
subsetting the list. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one remote internet address
|
|
specified by the remote internet address lower value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote port lower value.</strong> The lower value of the remote
|
|
system port range requested for subsetting the list. Valid values range from 1
|
|
to 65535. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all remote ports.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote port upper value.</strong> The upper value of the remote
|
|
system port range requested for subsetting the list. Valid values range from 1
|
|
to 65535. The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one remote port specified in remote
|
|
port lower value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> A reserved field. It must be x'00'.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCLQ0200">NCLQ0200 Format</a></h3>
|
|
|
|
<p>The following table shows the format of the IPv6 connection list qualifier
|
|
input parameter, named the NCLQ0200 format. For detailed descriptions of the
|
|
fields in the table, see <a href="#NCLQ0200_FIELD">Field Descriptions</a>.</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(10)</td>
|
|
<td align="left" valign="top" width="60%">Net connection type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">List request type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(12)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Local internet IPv6 address lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Local internet IPv6 address upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Remote internet IPv6 address lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Remote internet IPv6 address upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">104</td>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port lower value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">108</td>
|
|
<td align="center" valign="top">6C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port upper value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">112</td>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCLQ0200_FIELD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>List request type.</strong> The local internet address range, local
|
|
port range, remote internet address range, and remote port range for which
|
|
information is requested.</p>
|
|
|
|
<p>Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All objects returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SUBSET</em></td>
|
|
<td align="left" valign="top">Restrict the objects returned in the list to a
|
|
specified subset.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local internet IPv6 address lower value.</strong> The lower value of
|
|
the local system internet address range, in IPv6 address format, requested for
|
|
subsetting the list. Even though this field is defined as a character field, it
|
|
must be stored in binary. It is recommended that you use the Sockets in6_addr
|
|
structure.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all local internet IPv6 addresses.
|
|
Specify this value by filling the whole field with binary NULLs
|
|
(x'000000...').</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local internet IPv6 address upper value.</strong> The upper value of
|
|
the local system internet address range, in IPv6 address format, requested for
|
|
subsetting the list. Even though this field is defined as a character field, it
|
|
must be stored in binary. It is recommended that you use the Sockets in6_addr
|
|
structure.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one local internet IPv6 address
|
|
specified by the local internet IPv6 address lower value. Specify this value by
|
|
filling the whole field with binary NULLs (x'000000...').</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local port lower value.</strong> The lower value of the local system
|
|
port range requested for subsetting the list. Valid values range from 1 to
|
|
65535.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all local ports.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Local port upper value.</strong> The upper value of the local system
|
|
port range requested for subsetting the list. Valid values range from 1 to
|
|
65535.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one local port specified in local
|
|
port lower value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Net connection type.</strong> The type of connection or socket.</p>
|
|
|
|
<p>Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All connection types</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*TCP</em></td>
|
|
<td align="left" valign="top">A transmission control protocol (TCP) connection
|
|
or socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*UDP</em></td>
|
|
<td align="left" valign="top">A User Datagram Protocol (UDP) socket.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote internet IPv6 address lower value.</strong> The lower value
|
|
of the remote system internet IPv6 address range, in IPv6 address format,
|
|
requested for subsetting the list. Even though this field is defined as a
|
|
character field, it must be stored in binary. It is recommended that you use
|
|
the Sockets in6_addr structure.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all remote internet IPv6 addresses.
|
|
Specify this value by filling the whole field with binary NULLs
|
|
(x'000000...').</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote internet IPv6 address upper value.</strong> The upper value
|
|
of the remote system internet IPv6 address range, in IPv6 address format,
|
|
requested for subsetting the list. Even though this field is defined as a
|
|
character field, it must be stored in binary. It is recommended that you use
|
|
the Sockets in6_addr structure.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one remote internet IPv6 address
|
|
specified by the remote internet IPv6 address lower value. Specify this value
|
|
by filling the whole field with binary NULLs (x'000000...').</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote port lower value.</strong> The lower value of the remote
|
|
system port range requested for subsetting the list. Valid values range from 1
|
|
to 65535.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request all remote ports.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote port upper value.</strong> The upper value of the remote
|
|
system port range requested for subsetting the list. Valid values range from 1
|
|
to 65535.</p>
|
|
|
|
<p>The following is a special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Request only one remote port specified in remote
|
|
port lower value.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> A reserved field. It must be x'00'.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="FRCD">Format of Returned Connection Data</a></h3>
|
|
|
|
<p>To retrieve the list of TCP/IPv4 connections, request format <a href=
|
|
"#NCNN0100">NCNN0100</a>, and you will get a repeating list of NCNN0100 tables,
|
|
each one returning information about a single IPv4 connection. To retrieve the
|
|
list of TCP/IPv6 connections, request format <a href="#NCNN0200">NCNN0200</a>,
|
|
and you will get a repeating list of NCNN0200 tables, each one returning
|
|
information about a single IPv6 connection.</p>
|
|
<br>
|
|
<h3><a name="NCNN0100"></a>NCNN0100 Format</h3>
|
|
|
|
<p>The following information about a user space is returned for the NCNN0100
|
|
format. For detailed descriptions of the fields in the table, see <a href=
|
|
"#NCNN0100_FIELD">Field Descriptions</a>.</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(15)</td>
|
|
<td align="left" valign="top" width="60%">Remote address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">15</td>
|
|
<td align="center" valign="top">F</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote address binary</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(15)</td>
|
|
<td align="left" valign="top">Local address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">35</td>
|
|
<td align="center" valign="top">23</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local address binary</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP state</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Idle time in milliseconds</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">56</td>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Bytes in</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Bytes out</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Connection open type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">76</td>
|
|
<td align="center" valign="top">4C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Net connection type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">86</td>
|
|
<td align="center" valign="top">56</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Associated user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">98</td>
|
|
<td align="center" valign="top">62</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCNN0100_FIELD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Associated user
|
|
profile.</strong> The user profile of the job on the local system which first
|
|
performed a sockets API bind() of the socket.</p>
|
|
|
|
<p><strong>Note:</strong> This field does not reliably indicate the current
|
|
user of a connection or socket. To see a list of the jobs or tasks currently
|
|
using a connection or socket, use the Retrieve Network Connection Data
|
|
(QtocRtvNetCnnDta) API.</p>
|
|
|
|
<p><strong>Bytes in.</strong> The number of bytes received from the remote
|
|
host.</p>
|
|
|
|
<p><strong>Bytes out.</strong> The number of bytes sent to the remote host.</p>
|
|
|
|
<p><strong>Connection open type.</strong> The type of open that was done to
|
|
start this connection. This field only applies to TCP connections.</p>
|
|
|
|
<p>Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Passive. A remote host opens the connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Active. The local system opens the
|
|
connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Not supported. Connection open type not supported
|
|
by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Idle time in milliseconds.</strong> The length of time since the
|
|
last activity on this connection. The length of time is shown in
|
|
milliseconds.</p>
|
|
|
|
<p><strong>Local address.</strong> The local system internet address, in dotted
|
|
decimal format, of the connection.</p>
|
|
|
|
<p><strong>Local address binary.</strong> Binary representation of the local
|
|
address.</p>
|
|
|
|
<p><strong>Local port.</strong> The local system port number.</p>
|
|
|
|
<p><strong>Net connection type.</strong> The type of connection or socket.
|
|
Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*TCP</em></td>
|
|
<td align="left" valign="top">A transmission control protocol (TCP) connection
|
|
or socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*UDP</em></td>
|
|
<td align="left" valign="top">A User Datagram Protocol (UDP) socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*IPI</em></td>
|
|
<td align="left" valign="top">An Internet Protocol (IP) over Internetwork
|
|
Packet Exchange (IPX) connection or socket.
|
|
|
|
<p><strong>Note:</strong> As of V5R2,
|
|
IP over IPX is no longer supported.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*IPS</em></td>
|
|
<td align="left" valign="top">An Internet Protocol (IP) over SNA connection or
|
|
socket.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote address.</strong> The internet address, in dotted decimal
|
|
format, of the remote host.</p>
|
|
|
|
<p>The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">This connection is a listening or UDP socket so
|
|
this field does not apply. The "0" is returned as a left adjusted "0"
|
|
(x'F0404040...').</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote address binary.</strong> Binary representation of the remote
|
|
address.</p>
|
|
|
|
<p>The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">This connection is a listening or UDP socket so
|
|
this field does not apply.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote port.</strong> The remote host port number. Zero is shown if
|
|
the list entry is for a UDP socket.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>TCP state.</strong> A typical connection goes through the
|
|
states:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Listen. Waiting for a connection request from any
|
|
remote host.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">SYN-sent. Waiting for a matching connection
|
|
request after having sent connection request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">SYN-received. Waiting for a confirming connection
|
|
request acknowledgement.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Established. The normal state in which data is
|
|
transferred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">FIN-wait-1. Waiting for the remote host to
|
|
acknowledge the local system request to end the connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top">FIN-wait-2. Waiting for the remote host request
|
|
to end the connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>6</em></td>
|
|
<td align="left" valign="top">Close-wait. Waiting for an end connection request
|
|
from the local user.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>7</em></td>
|
|
<td align="left" valign="top">Closing. Waiting for an end connection request
|
|
acknowledgement from the remote host.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>8</em></td>
|
|
<td align="left" valign="top">Last-ACK. Waiting for the remote host to
|
|
acknowledge an end connection request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>9</em></td>
|
|
<td align="left" valign="top">Time-wait. Waiting to allow the remote host
|
|
enough time to receive the local system's acknowledgement to end the
|
|
connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>10</em></td>
|
|
<td align="left" valign="top">Closed. The connection has ended.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>11</em></td>
|
|
<td align="left" valign="top">State value not supported by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCNN0200">NCNN0200 Format</a></h3>
|
|
|
|
<p>The following information about a TCP/IPv6 connection is returned for the
|
|
NCNN0200 format. For detailed descriptions of the fields in the table, see <a
|
|
href="#NCNN0200_FIELD">Field Descriptions</a>.</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(45)</td>
|
|
<td align="left" valign="top" width="60%">Remote IPv6 address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">45</td>
|
|
<td align="center" valign="top">2D</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Remote IPv6 address binary</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">CHAR(45)</td>
|
|
<td align="left" valign="top">Local IPv6 address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">109</td>
|
|
<td align="center" valign="top">6D</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">112</td>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Local IPv6 address binary</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">128</td>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">132</td>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">136</td>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP state</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">140</td>
|
|
<td align="center" valign="top">8C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Idle time in milliseconds</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">144</td>
|
|
<td align="center" valign="top">90</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Bytes in</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">152</td>
|
|
<td align="center" valign="top">98</td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Bytes out</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">160</td>
|
|
<td align="center" valign="top">A0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Connection open type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">164</td>
|
|
<td align="center" valign="top">A4</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Net connection type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">174</td>
|
|
<td align="center" valign="top">AE</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Associated user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">184</td>
|
|
<td align="center" valign="top">B8</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Line Description<img src="deltaend.gif" alt="End of change"></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">194</td>
|
|
<td align="center" valign="top">C2</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCNN0200_FIELD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Associated user profile.</strong> The user profile of the job on the
|
|
local system which first performed a sockets API bind() of the socket.</p>
|
|
|
|
<p><strong>Note:</strong> This field does not reliably indicate the current
|
|
user of a connection or socket. To see a list of the jobs or tasks currently
|
|
using a connection or socket, use the Retrieve Network Connection Data
|
|
(QtocRtvNetCnnDta) API.</p>
|
|
|
|
<p><strong>Bytes in.</strong> The number of bytes received from the remote
|
|
host.</p>
|
|
|
|
<p><strong>Bytes out.</strong> The number of bytes sent to the remote host.</p>
|
|
|
|
<p><strong>Connection open type.</strong> The type of open that was done to
|
|
start this connection. This field only applies to TCP connections.</p>
|
|
|
|
<p>Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Passive. A remote host opens the connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Active. The local system opens the
|
|
connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Not supported. Connection open type not supported
|
|
by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Idle time in milliseconds.</strong> The length of time since the
|
|
last activity on this connection. The length of time is shown in
|
|
milliseconds.</p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change">
|
|
<strong>Line Description.</strong> The local system line description associated
|
|
with this connection. This field is only filled for connections bound to link
|
|
local unicast interfaces.<img src="deltaend.gif" alt="End of change"></p>
|
|
|
|
<p><strong>Local IPv6 address.</strong> The local system internet address, in
|
|
IPv6 address format, of the connection. This field is NULL padded.</p>
|
|
|
|
<p><strong>Local IPv6 address binary.</strong> Binary representation of the
|
|
local IPv6 address. Even though this field is defined as a character field, a
|
|
binary IPv6 address is returned in it.</p>
|
|
|
|
<p><strong>Local port.</strong> The port number of the local end of the
|
|
connection.</p>
|
|
|
|
<p><strong>Net connection type.</strong> The type of connection or socket.</p>
|
|
|
|
<p>Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*TCP</em></td>
|
|
<td align="left" valign="top">A transmission control protocol (TCP) connection
|
|
or socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*UDP</em></td>
|
|
<td align="left" valign="top">A User Datagram Protocol (UDP) socket.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Remote IPv6 address.</strong> The internet address, in IPv6 address
|
|
format, of the remote host. This field is NULL padded.</p>
|
|
|
|
<p>Special values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>::</em></td>
|
|
<td align="left" valign="top">This connection is a listening socket so this
|
|
field does not apply.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote IPv6 address binary.</strong> Binary representation of the
|
|
remote address. Even though this field is defined as a character field, a
|
|
binary IPv6 address is returned in it.</p>
|
|
|
|
<p>A special value that may be returned is:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">This connection is a listening socket so this
|
|
field does not apply. This value is returned as a binary 0.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote port.</strong> The port number of the remote end of the
|
|
connection.</p>
|
|
|
|
<p>Special values are:</p>
|
|
|
|
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">This connection is a listening socket so this
|
|
field does not apply.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>TCP state.</strong> A typical connection goes through the
|
|
states:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Listen. Waiting for a connection request from any
|
|
remote host.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">SYN-sent. Waiting for a matching connection
|
|
request after having sent connection request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">SYN-received. Waiting for a confirming connection
|
|
request acknowledgement.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Established. The normal state in which data is
|
|
transferred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">FIN-wait-1. Waiting for the remote host to
|
|
acknowledge the local system request to end the connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top">FIN-wait-2. Waiting for the remote host request
|
|
to end the connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>6</em></td>
|
|
<td align="left" valign="top">Close-wait. Waiting for an end connection request
|
|
from the local user.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>7</em></td>
|
|
<td align="left" valign="top">Closing. Waiting for an end connection request
|
|
acknowledgement from the remote host.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>8</em></td>
|
|
<td align="left" valign="top">Last-ACK. Waiting for the remote host to
|
|
acknowledge an end connection request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>9</em></td>
|
|
<td align="left" valign="top">Time-wait. Waiting to allow the remote host
|
|
enough time to receive the local system's acknowledgement to end the
|
|
connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>10</em></td>
|
|
<td align="left" valign="top">Closed. The connection has ended.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>11</em></td>
|
|
<td align="left" valign="top">State value not supported by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">TCP84C0 E</td>
|
|
<td width="85%" valign="top">TCP/IP stack not active.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">TCP84C5 E</td>
|
|
<td align="left" valign="top">Error providing TCP/IP Network Status list information.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">TCP84C6 E</td>
|
|
<td align="left" valign="top">Internal operations error - RESULT &1 CC &2 RC &3
|
|
ERRNO &4.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">TCP84C7 E</td>
|
|
<td align="left" valign="top">Connections list qualifier parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF0F03 E</td>
|
|
<td align="left" valign="top">Error in retrieving the user space that was created by the
|
|
caller.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td align="left" valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C1E E</td>
|
|
<td align="left" valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td align="left" valign="top">API contains a problem. See prior messages to determine why
|
|
the failure occurred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8100 E</td>
|
|
<td align="left" valign="top">All CPF81xx messages could be returned. xx is from 01 to
|
|
FF.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9801 E</td>
|
|
<td align="left" valign="top">Object &2 in library &3 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9802 E</td>
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9803 E</td>
|
|
<td align="left" valign="top">Cannot allocate object &2 in library &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9807 E</td>
|
|
<td align="left" valign="top">One or more libraries in library list deleted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9808 E</td>
|
|
<td align="left" valign="top">Cannot allocate one or more libraries on library list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9810 E</td>
|
|
<td align="left" valign="top">Library &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9820 E</td>
|
|
<td align="left" valign="top">Not authorized to use library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9830 E</td>
|
|
<td align="left" valign="top">Cannot assign library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V5R1
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
|
<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>
|
|
|