2939 lines
87 KiB
HTML
2939 lines
87 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>Retrieve Network Connection Data (QtocRtvNetCnnDta) 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 V5R1-->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- 050603 SGLEZ Made V5R4 changes -->
|
|
<!-- 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>Retrieve Network Connection Data (QtocRtvNetCnnDta) 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</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">Socket connection request</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">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 Retrieve Network
|
|
Connection Data (QtocRtvNetCnnDta) API retrieves detailed information about a
|
|
specified IPv4 or IPv6 network connection - including jobs using the
|
|
connection. It also retrieves information about IPv4 and IPv6 connection
|
|
totals.</p>
|
|
|
|
<p>TCP/IP must be active on this system, otherwise TCP84C0 message will be
|
|
issued.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The variable that is to receive the information requested. You can specify
|
|
the size of this area to be smaller than the format requested if you specify
|
|
the length of receiver variable parameter correctly. As a result, the API
|
|
returns only the data that the area can hold.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable. If this value is larger than the actual
|
|
size of the receiver variable, the result may not be predictable. The minimum
|
|
length is 8 bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the space information to be returned. The format names
|
|
supported are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCND0100</em></td>
|
|
<td align="left" valign="top">TCP/IPv4 connection totals. Refer to <a href=
|
|
"#NCND0100">NCND0100 Format</a> for details on the format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCND0200</em></td>
|
|
<td align="left" valign="top">Detailed TCP or UDP connection status for a
|
|
specific IPv4 socket connection in addition to TCP/IPv4 connection totals.
|
|
Refer to <a href="#NCND0100">NCND0100 Format</a> and <a href=
|
|
"#NCND0200">NCND0200 Format</a> for details on the format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCND1100</em></td>
|
|
<td align="left" valign="top">TCP/IPv6 connection totals. Refer to <a href=
|
|
"#NCND1100">NCND1100 Format</a> for details on the format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NCND1200</em></td>
|
|
<td align="left" valign="top">Detailed TCP or UDP connection status for a
|
|
specific IPv6 socket connection in addition to TCP/IPv6 connection totals.
|
|
Refer to <a href="#NCND1100">NCND1100 Format</a> and <a href=
|
|
"#NCND1200">NCND1200 Format</a> for details on the format.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Socket connection
|
|
request</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The protocol, local address, local port, remote address and remote port
|
|
identify the connection for which information is to be retrieved. This
|
|
parameter is ignored when format NCND0100 or format NCND1100 is requested.
|
|
Refer to <a href="#SCRF">Socket connection request format</a> for details on
|
|
the 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="SCRF">Socket
|
|
Connection Request Format</a></h3>
|
|
|
|
<p>Information passed in the socket connection request parameter must be in one
|
|
of the following two formats. The first format is for IPv4 connections, and the
|
|
second is for IPv6 connections. The value of the Protocol field determines the
|
|
format of the rest of the Socket Connection Request. For detailed descriptions
|
|
of the fields in the table, see <a href="#SCRF_FIELD">Field
|
|
Descriptions</a>.</p>
|
|
|
|
<br>
|
|
<h3>IPv4 connection (Protocol field value is 1 or 2)</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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Protocol</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local IPv4 address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote IPv4 address</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 port number</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>IPv6 connection (Protocol field value is 3 or 4)</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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Protocol</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Local IPv6 address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Local port number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Remote IPv6 address</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 number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="SCRF_FIELD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Local IPv4 address.</strong> The IPv4 address of the host at the
|
|
local end of the connection.</p>
|
|
|
|
<p><strong>Local IPv6 address.</strong> The IPv6 address of the host at the
|
|
local end of the connection. 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><strong>Local port number.</strong> The port number of the local end of the
|
|
connection.</p>
|
|
|
|
<p><strong>Protocol.</strong> The type and IP version of connection
|
|
protocol.</p>
|
|
|
|
<p>Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em> </td>
|
|
<td align="left" valign="top">TCP/IP connection totals when using format
|
|
NCND0100 or format NCND1100.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em> </td>
|
|
<td align="left" valign="top">TCP/IPv4 - A Transmission Control Protocol (TCP)
|
|
over IPv4 connection or socket request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em> </td>
|
|
<td align="left" valign="top">UDP/IPv4 - A User Datagram Protocol (UDP) over
|
|
IPv4 socket request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em> </td>
|
|
<td align="left" valign="top">TCP/IPv6 - A Transmission Control Protocol (TCP)
|
|
over IPv6 connection or socket request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em> </td>
|
|
<td align="left" valign="top">UDP/IPv6 - A User Datagram Protocol (UDP) over
|
|
IPv6 socket request.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote IPv4 address.</strong> The IPv4 address of the host at the
|
|
remote end of the connection.</p>
|
|
|
|
<p><strong>Remote IPv6 address.</strong> The IPv6 address of the host at the
|
|
remote end of the connection. 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><strong>Remote port number.</strong> The port number of the remote end of
|
|
the connection.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="FRCD">Format of Returned Connection Data</a></h3>
|
|
|
|
|
|
<p>To retrieve the current TCP/IPv4 connection totals, use format <a href=
|
|
"#NCND0100">NCND0100</a>.</p>
|
|
|
|
<p>To retrieve the current TCP/IPv6 connection totals, use format <a href=
|
|
"#NCND1100">NCND1100</a>.</p>
|
|
|
|
<p>For detailed TCP and UDP connection status for a specific IPv4 socket
|
|
connection in addition to the TCP/IPv4 connection totals, use format <a href=
|
|
"#NCND0200">NCND0200</a>.</p>
|
|
|
|
<p>For detailed TCP and UDP connection status for a specific IPv6 socket
|
|
connection in addition to the TCP/IPv6 connection totals, use format <a href=
|
|
"#NCND1200">NCND1200</a>.</p>
|
|
|
|
<br>
|
|
<h3><a name="NCND0100">NCND0100 Format</a></h3>
|
|
|
|
<p>Format NCND0100 returns information regarding the TCP/IPv4 connection
|
|
totals. For detailed descriptions of the fields in the table, see <a href=
|
|
"#NCND0100_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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Bytes returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP connections currently established</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP active opens</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">TCP passive opens</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP attempted opens that failed</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP established and then reset</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP segments sent</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">TCP retransmitted segments</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">TCP reset segments</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">TCP segments received</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">TCP segments received in error</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">UDP datagrams sent</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">UDP datagrams received</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">UDP datagrams not delivered application port not
|
|
found</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">UDP datagrams not delivered other datagrams in
|
|
error</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">Offset to additional information</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">Length of additional information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCND0100_FIELD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Bytes available.</strong> All of the available bytes for use in your
|
|
application.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of bytes returned to the user.
|
|
This may be some but not all the bytes available.</p>
|
|
|
|
<p><strong>Length of Additional Information.</strong>The length in bytes of
|
|
additional information returned that is not part of format NCND0100.</p>
|
|
|
|
<p><strong>Offset to Additional Information.</strong> The offset in bytes to
|
|
the rest of the information if a format other than NCND0100 is requested.</p>
|
|
|
|
<p><strong>TCP active opens.</strong> The number of times TCP connections have
|
|
made a direct transition to the SYN-SENT state from the CLOSED state. This
|
|
number is an indication of the number of times this local system opened a
|
|
connection to a remote system.</p>
|
|
|
|
<p><strong>TCP attempted opens that failed.</strong> The sum of the number of
|
|
times TCP connections have made a direct transition to a, CLOSED state from
|
|
either the SYN-SENT state or the SYN-RCVD state, or a LISTEN state from the
|
|
SYN-RCVD state.</p>
|
|
|
|
<p><strong>TCP connections currently established.</strong> The number if TCP
|
|
connections for which the current state is either ESTABLISHED or
|
|
CLOSE-WAIT.</p>
|
|
|
|
<p><strong>TCP established and then reset.</strong> The number of times TCP
|
|
connections have made a direct transition to the CLOSED state from either the
|
|
ESTABLISHED state or the CLOSE-WAIT state.</p>
|
|
|
|
<p><strong>TCP passive opens.</strong> The number of times TCP connections have
|
|
made a direct transition to the SYN-RCVD state from the LISTEN state. This
|
|
number is an indication of the number of times a remote system opened a
|
|
connection to this system.</p>
|
|
|
|
<p><strong>TCP reset segments.</strong> The number of TCP segments sent
|
|
containing the RST flag.</p>
|
|
|
|
<p><strong>TCP retransmitted segments.</strong> The number of TCP segments
|
|
transmitted containing one or more previously transmitted octets.</p>
|
|
|
|
<p><strong>TCP segments received.</strong> The total number of segments
|
|
received, including those received in error. This count includes segments
|
|
received on currently established connections.</p>
|
|
|
|
<p><strong>TCP segments received in error.</strong> The total number of
|
|
segments received in error (for example, bad TCP checksums).</p>
|
|
|
|
<p><strong>TCP segments sent.</strong> The total number of segments sent,
|
|
including those on current connections but excluding those containing only
|
|
retransmitted octets.</p>
|
|
|
|
<p><strong>UDP datagrams not delivered application port not found.</strong> The
|
|
total number of received UDP datagrams for UDP users for which there was no
|
|
application at the destination port.</p>
|
|
|
|
<p><strong>UDP datagrams not delivered other datagrams in error.</strong> The
|
|
number of received UDP datagrams that could not be delivered for reasons other
|
|
than the lack of an application at the destination port.</p>
|
|
|
|
<p><strong>UDP datagrams received.</strong> The total number of segments
|
|
received, including those received in error. This count includes segments
|
|
received on currently established connections.</p>
|
|
|
|
<p><strong>UDP datagrams sent.</strong> The total number of UDP datagrams sent
|
|
from this entity.</p>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCND0200">NCND0200 Format</a></h3>
|
|
|
|
<p>This format returns detailed information about the TCP connection status in
|
|
addition to the TCP/IPv4 connection totals (format NCND0100). For detailed
|
|
descriptions of the fields in the table, see <a href="#NCND0200_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%"><br>
|
|
</td>
|
|
<td align="left" valign="top" width="60%">Returns everything from format
|
|
NCND0100</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top" colspan="2">Decimal and hexadecimal offsets are
|
|
reached by using the offset to additional information field in format
|
|
NCND0100. This applies to all entries below.</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Protocol</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local IP address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote IP address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Round-trip time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Round-trip variance</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing bytes buffered</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">User send next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Send next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Send unacknowledged</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing push number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing urgency number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing window number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming bytes buffered</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Receive next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">User receive next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming push number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming urgency number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming window number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Total retransmissions</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Current retransmissions</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum window size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Current window size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Last update</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Last update acknowledged</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Congestion window</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Slow start threshold</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum segment size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Initial send sequence number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Initial receive sequence number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Connection transport layer</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP state</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Connection open type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Idle time in milliseconds</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(40)</td>
|
|
<td align="left" valign="top">IP options</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes in</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes out</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Socket state</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of socket options associated with
|
|
connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of socket options associated with
|
|
connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Entry length for list of socket options
|
|
associated with connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of jobs associated with
|
|
connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of jobs associated with connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Entry length for list of jobs associated with
|
|
connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Associated user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>List of Socket Options.</h3>
|
|
|
|
<p>These fields repeat for each socket option.</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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Socket option</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Option value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>List of Jobs/Tasks Associated with this Connection.</h3>
|
|
|
|
<p>These fields repeat for each job or task.</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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Format entry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Task name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job user name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Job number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">46</td>
|
|
<td align="center" valign="top">2E</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Internal job identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">62</td>
|
|
<td align="center" valign="top">3E</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCND0200_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 List of Jobs/Tasks Associated with this
|
|
Connection. </p>
|
|
|
|
<p><strong>Bytes in.</strong> The total number of bytes received on the
|
|
connection, including framing characters.</p>
|
|
|
|
<p><strong>Bytes out.</strong> The total number of bytes transmitted on the
|
|
connection, including framing characters.</p>
|
|
|
|
<p><strong>Congestion window.</strong> The number of segments that are sent on
|
|
the next transmission. If an acknowledgment is received, the number is
|
|
increased. If an acknowledgment is not received, the number is reset to the
|
|
smallest allowable number. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Connection open type.</strong> A TCP connection can be opened in the
|
|
following ways:</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">Unsupported - Connection open type not supported
|
|
by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Connection transport layer.</strong> The transport that a connection
|
|
is using:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">IPS</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">IPX
|
|
|
|
<p><strong>Note:</strong> As of V5R2,
|
|
IPX is no longer supported.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">TCP/IP</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Current retransmissions.</strong> The number of times the local
|
|
system retransmitted the current segment without receiving an acknowledgment.
|
|
This is sometimes referred to as the 'backoff count. This field is only valid
|
|
for TCP connections.</p>
|
|
|
|
<p><strong>Current window size.</strong> The current send window size in bytes.
|
|
This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Entry length for list of jobs associated with connection.</strong>
|
|
The entry length in bytes of each element in the list of job connections
|
|
returned with this format. A value of zero is returned if the list is
|
|
empty.</p>
|
|
|
|
<p><strong>Entry length for list of socket options associated with
|
|
connection.</strong> The entry length in bytes of each element in the list of
|
|
socket options returned with this format. A value of zero is returned if the
|
|
list is empty.</p>
|
|
|
|
<p><strong>Format entry.</strong> Type of list format for job or task
|
|
connections.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Represents a job format. For this format the task
|
|
name will be blank.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Represents a task format. For this format the job
|
|
name, username, number and internal identifier will be blank.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Idle time.</strong> The length of time since the last activity on
|
|
this connection. The length of time is returned in milliseconds.</p>
|
|
|
|
<p><strong>Incoming bytes buffered.</strong> The current number of bytes that
|
|
are received and buffered by TCP. These bytes are available to be read by an
|
|
application.</p>
|
|
|
|
<p><strong>Incoming push number.</strong> The sequence number of the last byte
|
|
of pushed data in the incoming data stream. This value is zero if no push data
|
|
is in the incoming data stream. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>Incoming urgency number.</strong> The sequence number of the last
|
|
byte of urgent data in the incoming data stream. This value is zero if no
|
|
urgent data is in the incoming data stream. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>Incoming window number.</strong> The largest sequence number in the
|
|
incoming window of this connection. Data bytes in the incoming stream having
|
|
sequence numbers larger than this number are not accepted. This field is only
|
|
valid for TCP connections.</p>
|
|
|
|
<p><strong>Initial receive sequence number.</strong> The first sequence number
|
|
received on this connection. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Initial send sequence number.</strong> The first sequence number
|
|
sent on this connection. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>IP options.</strong> Used in displaying the IP datagram options that
|
|
may have been specified for a connection.</p>
|
|
|
|
<p><strong>Internal job identifier.</strong> A value sent to other APIs to
|
|
speed the process of locating the job on the system.</p>
|
|
|
|
<p><strong>Job name.</strong> The simple job name as identified to the
|
|
system.</p>
|
|
|
|
<p><strong>Job number.</strong> System-assigned job or task number.</p>
|
|
|
|
<p><strong>Job user name.</strong> The user name identifies the user profile
|
|
under which the job is started. The following special value may be
|
|
returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SIGNON</em></td>
|
|
<td align="left" valign="top">This connection is a telnet connection and the
|
|
system is performing sign-on processing or is displaying a sign-on prompt on
|
|
it. In this case the Job name field will contain the network device name, the
|
|
Job number and Internal job identifier fields will be empty.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Last update.</strong> The sequence number of the incoming segment
|
|
used for the last window update that occurred on the connection. This field is
|
|
only valid for TCP connections.</p>
|
|
|
|
<p><strong>Last update acknowledged.</strong> The acknowledgment number of the
|
|
incoming segment used for the last window update that occurred on the
|
|
connection. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Local IP address.</strong> The local address of this connection on
|
|
this system.</p>
|
|
|
|
<p><strong>Local port number.</strong> Your local system port number.</p>
|
|
|
|
<p><strong>Maximum segment size.</strong> The size in bytes of the largest
|
|
segment that may be transmitted on this connection. This field is only valid
|
|
for TCP connections.</p>
|
|
|
|
<p><strong>Maximum window size.</strong> The largest size of the send window,
|
|
in bytes, during the entire time the connection has been active. This field is
|
|
only valid for TCP connections.</p>
|
|
|
|
<p><strong>Number of jobs associated with connection.</strong> The number of
|
|
elements in the list of job connections returned with this format. A value of
|
|
zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Number of socket options associated with connection.</strong> The
|
|
number of elements in the list of socket options returned with this format. A
|
|
value of zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Offset to list of jobs associated with connection.</strong> The
|
|
offset in bytes to the first element in the list of job connections returned
|
|
with this format. A value of zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Offset to list of socket options associated with
|
|
connection.</strong> The offset in bytes to the first element in the list of
|
|
socket options returned with this format. A value of zero is returned if the
|
|
list is empty.</p>
|
|
|
|
<p><strong>Option value.</strong> The value returned for a particular socket
|
|
option. Option is set if a nonzero value is returned.</p>
|
|
|
|
<p><strong>Outgoing bytes buffered.</strong> The current number of bytes that
|
|
an application has requested to send, but TCP has not yet sent. If TCP has sent
|
|
the bytes to the remote system but has not yet received an acknowledgment, the
|
|
bytes are considered 'not sent'. They are included in this count.</p>
|
|
|
|
<p><strong>Outgoing push number.</strong> The sequence number of the last byte
|
|
of push data in the outgoing stream. This value is zero if no push data is in
|
|
the outgoing data stream. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Outgoing urgency number.</strong> The sequence number of the last
|
|
byte of urgent data in the outgoing data stream. This value is zero if no
|
|
urgent data is in the outgoing data stream. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>Outgoing window number.</strong> The largest sequence number in the
|
|
send window of the connection. The local TCP application cannot send data bytes
|
|
with sequence numbers greater than the outgoing window number.</p>
|
|
|
|
<p><strong>Protocol.</strong> Identifies the type of connection protocol.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top"><strong>TCP -</strong> A Transmission Control
|
|
Protocol (TCP) connection or socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top"><strong>UDP -</strong> A User Datagram Protocol
|
|
(UDP) socket.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Receive next.</strong> The next sequence number the local TCP is
|
|
expecting to receive.</p>
|
|
|
|
<p><strong>Remote IP address.</strong> The internet address of the remote host.
|
|
Zero is shown, if the list entry is for a UDP socket.</p>
|
|
|
|
<p><strong>Remote port number.</strong> The remote host port number. Zero is
|
|
shown, if the list entry is for a UDP socket.</p>
|
|
|
|
<p><strong>Round-trip time.</strong> The smoothed round-trip time interval in
|
|
milliseconds. This is a measure of the time required for a segment on the
|
|
connection to arrive at its destination, to be processed, and to return an
|
|
acknowledgment to the client. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Round-trip variance.</strong>The variance in milliseconds from the
|
|
previous round-trip time. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Send next.</strong> The sequence number of the next byte of data
|
|
that the local TCP application sends to the remote TCP application.</p>
|
|
|
|
<p><strong>Send unacknowledged.</strong> The sequence number of the last
|
|
segment sent that was not acknowledged. This is the smallest sequence number of
|
|
the send window. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Slow start threshold.</strong> The current values for the slow-start
|
|
threshold and the congestion window are indirect indicators of the flow of data
|
|
through a TCP connection. These values are used by TCP as part of a congestion
|
|
control algorithm. This algorithm ensures that this system sends data at a slow
|
|
rate at first. After the first data has been successfully sent, the rate in
|
|
which data is sent increases. This change is made in a controlled manner that
|
|
is dependent on the amount of congestion in the network. Congestion control
|
|
occurs both at connection start time and when congestion is detected. The
|
|
values used for the slow-start threshold and the congestion window are
|
|
determined by TCP and cannot be set by the user.</p>
|
|
|
|
<p><strong>Socket option.</strong> Socket options for this connection.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top"><strong>Socket broadcast option</strong>
|
|
Determine if messages can be sent to the broadcast address. This option
|
|
is only supported for sockets with an address family of AF_INET and type
|
|
SOCK_DGRAM or SOCK_RAW. Option is set if a nonzero value is returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top"><strong>Socket bypass route option -</strong>
|
|
Determine if the normal routing mechanism is being bypassed. This option is
|
|
only supported by sockets with an address family of AF_INET or AF_INET6.
|
|
Option is set if a nonzero value is returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top"><strong>Socket debug option -</strong> Determine
|
|
if low-level debugging is active. Option is set if a nonzero value is
|
|
returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top"><strong>Socket error -</strong> Return any
|
|
pending errors in the socket. The value returned corresponds to the standard
|
|
error codes.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top"><strong>Socket keep alive option -</strong>
|
|
Determine if the connection is being kept up by periodic transmissions. This
|
|
option is only supported for sockets with an address family of AF_INET or
|
|
AF_INET6 and type SOCK_STREAM. Option is set if a nonzero value is returned.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>6</em></td>
|
|
<td align="left" valign="top"><strong>Socket linger option -</strong> Determine
|
|
whether the system attempts to deliver any buffered data or if the system
|
|
discards it when a close() is issued. For sockets that are using a
|
|
connection-oriented transport service with an address family of AF_INET or
|
|
AF_INET6, the default is off (which means that the system attempts to send any
|
|
queued data, with an infinite wait-time).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>7</em></td>
|
|
<td align="left" valign="top"><strong>Socket linger time -</strong> Determine
|
|
how much time in seconds the system will wait to send buffered data.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>8</em></td>
|
|
<td align="left" valign="top"><strong>Socket out-of-band data option -</strong>
|
|
Determine if out-of-band data is received inline with normal data. This option
|
|
is only supported for sockets with an address family of AF_INET or AF_INET6.
|
|
Option is set if a nonzero value is returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>9</em></td>
|
|
<td align="left" valign="top"><strong>Socket receive buffer size -</strong>
|
|
Determine the size of the receive buffer.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>10</em></td>
|
|
<td align="left" valign="top"><strong>Socket receive low-water mark size
|
|
-</strong> Determine the size of the receive low-water mark. The default size
|
|
is 1. This option is only supported for sockets with type SOCK_STREAM.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>11</em></td>
|
|
<td align="left" valign="top"><strong>Socket reuse address option -</strong>
|
|
Determine if the local socket address can be reused. This option is only
|
|
supported by sockets with an address family of AF_INET or AF_INET6 and
|
|
with type SOCK_STREAM or SOCK_DGRAM. Option is set if a nonzero value is
|
|
returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>12</em></td>
|
|
<td align="left" valign="top"><strong>Socket send buffer size -</strong>
|
|
Determine the size of the send buffer.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>13</em></td>
|
|
<td align="left" valign="top"><strong>Socket type value -</strong> Determine
|
|
the value for the socket type.
|
|
|
|
<table cellpadding="5">
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Stream type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Datagram type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Raw type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">Sequential packet type.</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Socket state.</strong> The current state of the socket.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Uninitialized</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Unbound</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Bound</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Listening</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">Connecting</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top">Connected</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>6</em></td>
|
|
<td align="left" valign="top">Disconnected</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>7</em></td>
|
|
<td align="left" valign="top">Error</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Task name.</strong> The task name as identified to the system.</p>
|
|
|
|
<p><strong>TCP state.</strong> A typical connection goes through the
|
|
states:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top">0</td>
|
|
<td align="left" valign="top">Listen, waiting for a connection request from any
|
|
remote host.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1</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">2</td>
|
|
<td align="left" valign="top">SYN-received, waiting for a confirming connection
|
|
request acknowledgement.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">3</td>
|
|
<td align="left" valign="top">Established, the normal state in which data is
|
|
transferred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">4</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">5</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">6</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">7</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">8</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">9</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">10</td>
|
|
<td align="left" valign="top">Closed, the connection has ended.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">11</td>
|
|
<td align="left" valign="top">State value not supported by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Total retransmissions.</strong> The total number of times the local
|
|
system retransmitted a segment because an acknowledgment was not received. This
|
|
is a cumulative count of all segments resent during the entire time the
|
|
connection has been active. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>User send next.</strong> The sequence number of the next byte of
|
|
data to be sent by the client application. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>User receive next.</strong> The sequence number of the next byte to
|
|
be passed to the application by TCP.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCND1100">NCND1100 Format</a></h3>
|
|
|
|
<p>Format NCND1100 returns information regarding the TCP/IPv6 connection
|
|
totals. For detailed descriptions of the fields in the table, see <a href=
|
|
"#NCND1100_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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Bytes returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP connections currently established</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP active opens</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">TCP passive opens</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP attempted opens that failed</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP established and then reset</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP segments sent</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">TCP retransmitted segments</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">TCP reset segments</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">TCP segments received</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">TCP segments received in error</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">UDP datagrams sent</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">UDP datagrams received</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">UDP datagrams not delivered - application port
|
|
not found</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">UDP datagrams not delivered - other datagrams in
|
|
error</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">Offset to additional information</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">Length of additional information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCND1100_FIELD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Bytes available.</strong> All of the available bytes for use in your
|
|
application.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of bytes returned to the user.
|
|
This may be some but not all the bytes available.</p>
|
|
|
|
<p><strong>Length of Additional Information.</strong>The length in bytes of
|
|
additional information returned that is not part of format NCND0100.</p>
|
|
|
|
<p><strong>Offset to Additional Information.</strong> The offset in bytes to
|
|
the rest of the information if a format other than NCND0100 is requested.</p>
|
|
|
|
<p><strong>TCP active opens.</strong> The number of times TCP connections have
|
|
made a direct transition to the SYN-SENT state from the CLOSED state. This
|
|
number is an indication of the number of times this local system opened a
|
|
connection to a remote system.</p>
|
|
|
|
<p><strong>TCP attempted opens that failed.</strong> The sum of the number of
|
|
times TCP connections have made a direct transition to a, CLOSED state from
|
|
either the SYN-SENT state or the SYN-RCVD state, or a LISTEN state from the
|
|
SYN-RCVD state.</p>
|
|
|
|
<p><strong>TCP connections currently established.</strong> The number if TCP
|
|
connections for which the current state is either ESTABLISHED or
|
|
CLOSE-WAIT.</p>
|
|
|
|
<p><strong>TCP established and then reset.</strong> The number of times TCP
|
|
connections have made a direct transition to the CLOSED state from either the
|
|
ESTABLISHED state or the CLOSE-WAIT state.</p>
|
|
|
|
<p><strong>TCP passive opens.</strong> The number of times TCP connections have
|
|
made a direct transition to the SYN-RCVD state from the LISTEN state. This
|
|
number is an indication of the number of times a remote system opened a
|
|
connection to this system.</p>
|
|
|
|
<p><strong>TCP reset segments.</strong> The number of TCP segments sent
|
|
containing the RST flag.</p>
|
|
|
|
<p><strong>TCP retransmitted segments.</strong> The number of TCP segments
|
|
transmitted containing one or more previously transmitted octets.</p>
|
|
|
|
<p><strong>TCP segments received.</strong> The total number of segments
|
|
received, including those received in error. This count includes segments
|
|
received on currently established connections.</p>
|
|
|
|
<p><strong>TCP segments received in error.</strong> The total number of
|
|
segments received in error (for example, bad TCP checksums).</p>
|
|
|
|
<p><strong>TCP segments sent.</strong> The total number of segments sent,
|
|
including those on current connections but excluding those containing only
|
|
retransmitted octets.</p>
|
|
|
|
<p><strong>UDP datagrams not delivered - application port not found.</strong>
|
|
The total number of received UDP datagrams for UDP users for which there was no
|
|
application at the destination port.</p>
|
|
|
|
<p><strong>UDP datagrams not delivered - other datagrams in error.</strong> The
|
|
number of received UDP datagrams that could not be delivered for reasons other
|
|
than the lack of an application at the destination port.</p>
|
|
|
|
<p><strong>UDP datagrams received.</strong> The total number of segments
|
|
received, including those received in error. This count includes segments
|
|
received on currently established connections.</p>
|
|
|
|
<p><strong>UDP datagrams sent.</strong> The total number of UDP datagrams sent
|
|
from this entity.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCND1200">NCND1200
|
|
Format</a></h3>
|
|
|
|
<p>This format returns detailed information about the TCP connection status in
|
|
addition to the TCP/IPv6 connection totals (format NCND1100). For detailed
|
|
descriptions of the fields in the table, see <a href="#NCND1200_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%"><br>
|
|
</td>
|
|
<td align="left" valign="top" width="60%">Returns everything from format
|
|
NCND1100</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top" colspan="2">Decimal and hexadecimal offsets are
|
|
reached by using the offset to additional information field in format
|
|
NCND1100. This applies to all entries below.</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Protocol</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Local IPv6 address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Local port number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Remote IPv6 address</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Remote port number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Round-trip time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Round-trip variance</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing bytes buffered</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">User send next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Send next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Send unacknowledged</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing push number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing urgency number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Outgoing window number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming bytes buffered</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Receive next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">User receive next</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming push number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming urgency number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Incoming window number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Total retransmissions</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Current retransmissions</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum window size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Current window size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Last update</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Last update acknowledged</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Congestion window</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Slow start threshold</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum segment size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Initial send sequence number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Initial receive sequence number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Connection transport layer</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">TCP state</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Connection open type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Idle time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Bytes in</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(8)</td>
|
|
<td align="left" valign="top">Bytes out</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Socket state</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Associated user profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of socket options associated with
|
|
connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of socket options associated with
|
|
connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Entry length for list of socket options
|
|
associated with connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of jobs associated with
|
|
connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of jobs associated with connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2"></td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Entry length for list of jobs associated with
|
|
connection</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>List of Socket Options.</h3>
|
|
|
|
<p>These fields repeat for each socket option.</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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Socket option</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Option value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>List of Jobs/Tasks Associated with this Connection.</h3>
|
|
|
|
<p>These fields repeat for each job or task.</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%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Entry type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Task name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job user name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Job number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">46</td>
|
|
<td align="center" valign="top">2E</td>
|
|
<td align="left" valign="top">CHAR(16)</td>
|
|
<td align="left" valign="top">Internal job identifier</td>
|
|
</tr>
|
|
<tr>
|
|
|
|
<td align="center" valign="top">62</td>
|
|
<td align="center" valign="top">3E</td>
|
|
<td align="left" valign="top"> </td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="NCND1200_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 List of Jobs/Tasks Associated with this
|
|
Connection.</p>
|
|
|
|
<p><strong>Bytes in.</strong> The total number of bytes received on the
|
|
connection, including framing characters.</p>
|
|
|
|
<p><strong>Bytes out.</strong> The total number of bytes transmitted on the
|
|
connection, including framing characters.</p>
|
|
|
|
<p><strong>Congestion window.</strong> The number of segments that are sent on
|
|
the next transmission. If an acknowledgment is received, the number is
|
|
increased. If an acknowledgment is not received, the number is reset to the
|
|
smallest allowable number. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Connection open type.</strong> The method in which the TCP
|
|
connection was opened.</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 opened the
|
|
connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Active - The local system opened the
|
|
connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Unsupported - Connection open type not supported
|
|
by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Connection transport layer.</strong> The transport that the
|
|
connection is using.</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">IPS</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">IPX
|
|
|
|
<p><strong>Note:</strong> As of V5R2,
|
|
IPX is no longer supported.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">TCP/IP</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Current retransmissions.</strong> The number of times the local
|
|
system retransmitted the current segment without receiving an acknowledgment.
|
|
This is sometimes referred to as the 'backoff count'. This field is only valid
|
|
for TCP connections.</p>
|
|
|
|
<p><strong>Current window size.</strong> The current send window size in bytes.
|
|
This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Entry length for list of jobs associated with connection.</strong>
|
|
The entry length in bytes of each element in the list of job connections
|
|
returned with this format. A value of zero is returned if the list is
|
|
empty.</p>
|
|
|
|
<p><strong>Entry length for list of socket options associated with
|
|
connection.</strong> The entry length in bytes of each element in the list of
|
|
socket options returned with this format. A value of zero is returned if the
|
|
list is empty.</p>
|
|
|
|
<p><strong>Entry type.</strong> Specifies whether this entry is a job or a
|
|
task.</p>
|
|
|
|
<p>Possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Represents a job format. For this format the task
|
|
name field is not applicable.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Represents a task format. For this format the job
|
|
name, username, number and internal job identifier fields are not
|
|
applicable.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Idle time.</strong> The length of time since the last activity on
|
|
this connection. The length of time is returned in milliseconds.</p>
|
|
|
|
<p><strong>Incoming bytes buffered.</strong> The current number of bytes that
|
|
are received and buffered by TCP. These bytes are available to be read by an
|
|
application.</p>
|
|
|
|
<p><strong>Incoming push number.</strong> The sequence number of the last byte
|
|
of pushed data in the incoming data stream. This value is zero if no push data
|
|
is in the incoming data stream. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>Incoming urgency number.</strong> The sequence number of the last
|
|
byte of urgent data in the incoming data stream. This value is zero if no
|
|
urgent data is in the incoming data stream. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>Incoming window number.</strong> The largest sequence number in the
|
|
incoming window of this connection. Data bytes in the incoming stream having
|
|
sequence numbers larger than this number are not accepted. This field is only
|
|
valid for TCP connections.</p>
|
|
|
|
<p><strong>Initial receive sequence number.</strong> The first sequence number
|
|
received on this connection. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Initial send sequence number.</strong> The first sequence number
|
|
sent on this connection. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Internal job identifier.</strong> A value sent to other APIs to
|
|
speed the process of locating the job on the system.</p>
|
|
|
|
<p><strong>Job name.</strong> The simple job name as identified to the
|
|
system.</p>
|
|
|
|
<p><strong>Job number.</strong> System-assigned job or task number.</p>
|
|
|
|
<p><strong>Job user name.</strong> The user name identifies the user profile
|
|
under which the job is started.</p>
|
|
|
|
<p>The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SIGNON</em></td>
|
|
<td align="left" valign="top">This connection is a telnet connection and the
|
|
system is performing sign-on processing or is displaying a sign-on prompt on
|
|
it. In this case the Job name field will contain the network device name, and
|
|
the Job number and Internal job identifier fields will be empty.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Last update.</strong> The sequence number of the incoming segment
|
|
used for the last window update that occurred on the connection. This field is
|
|
only valid for TCP connections.</p>
|
|
|
|
<p><strong>Last update acknowledged.</strong> The acknowledgment number of the
|
|
incoming segment used for the last window update that occurred on the
|
|
connection. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Local IPv6 address.</strong> The local system internet address, in
|
|
IPv6 address format, of the connection. Even though this field is defined as a
|
|
character field, a binary IPv6 address is returned in it.</p>
|
|
|
|
<p><strong>Local port number.</strong> The port number of the local end of the
|
|
connection.</p>
|
|
|
|
<p><strong>Maximum segment size.</strong> The size in bytes of the largest
|
|
segment that may be transmitted on this connection. This field is only valid
|
|
for TCP connections.</p>
|
|
|
|
<p><strong>Maximum window size.</strong> The largest size of the send window,
|
|
in bytes, during the entire time the connection has been active. This field is
|
|
only valid for TCP connections.</p>
|
|
|
|
<p><strong>Number of jobs associated with connection.</strong> The number of
|
|
elements in the list of job connections returned with this format. A value of
|
|
zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Number of socket options associated with connection.</strong> The
|
|
number of elements in the list of socket options returned with this format. A
|
|
value of zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Offset to list of jobs associated with connection.</strong> The
|
|
offset in bytes to the first element in the list of job connections returned
|
|
with this format. A value of zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Offset to list of socket options associated with
|
|
connection.</strong> The offset in bytes to the first element in the list of
|
|
socket options returned with this format. A value of zero is returned if the
|
|
list is empty.</p>
|
|
|
|
<p><strong>Option value.</strong> The value returned for a particular socket
|
|
option. The socket option is set if a nonzero value is returned.</p>
|
|
|
|
<p><strong>Outgoing bytes buffered.</strong> The current number of bytes that
|
|
an application has requested to send, but TCP has not yet sent. If TCP has sent
|
|
the bytes to the remote system but has not yet received an acknowledgment, the
|
|
bytes are considered 'not sent'. They are included in this count.</p>
|
|
|
|
<p><strong>Outgoing push number.</strong> The sequence number of the last byte
|
|
of push data in the outgoing stream. This value is zero if no push data is in
|
|
the outgoing data stream. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Outgoing urgency number.</strong> The sequence number of the last
|
|
byte of urgent data in the outgoing data stream. This value is zero if no
|
|
urgent data is in the outgoing data stream. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>Outgoing window number.</strong> The largest sequence number in the
|
|
send window of the connection. The local TCP application cannot send data bytes
|
|
with sequence numbers greater than the outgoing window number.</p>
|
|
|
|
<p><strong>Protocol.</strong> Identifies the type of connection protocol.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top"><strong>TCP -</strong> A Transmission Control
|
|
Protocol (TCP) connection or socket.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em><strong>2</strong></em></td>
|
|
<td align="left" valign="top"><strong>UDP -</strong> A User Datagram Protocol
|
|
(UDP) socket.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Receive next.</strong> The next sequence number that TCP is
|
|
expecting to receive.</p>
|
|
|
|
<p><strong>Remote IPv6 address.</strong> The local system internet address, in
|
|
IPv6 address format, of the connection. Even though this field is defined as a
|
|
character field, a binary IPv6 address is returned in it.</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 socket, and
|
|
there is no remote IPv6 address. The zero is returned as a series of binary
|
|
NULLs (x'000000...')</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Remote port number.</strong> The port number of the remote end of
|
|
the connection.</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 socket and there
|
|
is no remote port number.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Round-trip time.</strong> The smoothed round-trip time interval in
|
|
milliseconds. This is a measure of the time required for a segment on the
|
|
connection to arrive at its destination, to be processed, and to return an
|
|
acknowledgment to the client. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Round-trip variance.</strong>The variance in milliseconds from the
|
|
previous round-trip time. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Send next.</strong> The sequence number of the next byte of data
|
|
that the local TCP application sends to the remote TCP application.</p>
|
|
|
|
<p><strong>Send unacknowledged.</strong> The sequence number of the last
|
|
segment sent that was not acknowledged. This is the smallest sequence number of
|
|
the send window. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>Slow start threshold.</strong> The current values for the slow-start
|
|
threshold and the congestion window are indirect indicators of the flow of data
|
|
through a TCP connection. These values are used by TCP as part of a congestion
|
|
control algorithm. This algorithm ensures that this system sends data at a slow
|
|
rate at first. After the first data has been successfully sent, the rate in
|
|
which data is sent increases. This change is made in a controlled manner that
|
|
is dependent on the amount of congestion in the network. Congestion control
|
|
occurs both at connection start time and when congestion is detected. The
|
|
values used for the slow-start threshold and the congestion window are
|
|
determined by TCP and cannot be set by the user.</p>
|
|
|
|
<p><strong>Socket option.</strong> Socket options for this connection.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top"><strong>Socket broadcast option</strong>
|
|
Determine if messages can be sent to the broadcast address. This option
|
|
is only supported for sockets with an address family of AF_INET and type
|
|
SOCK_DGRAM or SOCK_RAW. Option is set if a nonzero value is returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top"><strong>Socket bypass route option -</strong>
|
|
Determine if the normal routing mechanism is being bypassed. This option is
|
|
only supported by sockets with an address family of AF_INET or AF_INET6.
|
|
Option is set if a nonzero value is returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top"><strong>Socket debug option -</strong> Determine
|
|
if low-level debugging is active. Option is set if a nonzero value is
|
|
returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top"><strong>Socket error -</strong> Return any
|
|
pending errors in the socket. The value returned corresponds to the standard
|
|
error codes.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top"><strong>Socket keep alive option -</strong>
|
|
Determine if the connection is being kept up by periodic transmissions. This
|
|
option is only supported for sockets with an address family of AF_INET or
|
|
AF_INET6 and type SOCK_STREAM. Option is set if a nonzero value is returned.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>6</em></td>
|
|
<td align="left" valign="top"><strong>Socket linger option -</strong> Determine
|
|
whether the system attempts to deliver any buffered data or if the system
|
|
discards it when a close() is issued. For sockets that are using a
|
|
connection-oriented transport service with an address family of AF_INET or
|
|
AF_INET6, the default is off (which means that the system attempts to send any
|
|
queued data, with an infinite wait-time).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>7</em></td>
|
|
<td align="left" valign="top"><strong>Socket linger time -</strong> Determine
|
|
how much time in seconds the system will wait to send buffered data.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>8</em></td>
|
|
<td align="left" valign="top"><strong>Socket out-of-band data option -</strong>
|
|
Determine if out-of-band data is received inline with normal data. This option
|
|
is only supported for sockets with an address family of AF_INET or AF_INET6.
|
|
Option is set if a nonzero value is returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>9</em></td>
|
|
<td align="left" valign="top"><strong>Socket receive buffer size -</strong>
|
|
Determine the size of the receive buffer.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>10</em></td>
|
|
<td align="left" valign="top"><strong>Socket receive low-water mark size
|
|
-</strong> Determine the size of the receive low-water mark. The default size
|
|
is 1. This option is only supported for sockets with type SOCK_STREAM.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>11</em></td>
|
|
<td align="left" valign="top"><strong>Socket reuse address option -</strong>
|
|
Determine if the local socket address can be reused. This option is only
|
|
supported by sockets with an address family of AF_INET or AF_INET6 and
|
|
with type SOCK_STREAM or SOCK_DGRAM. Option is set if a nonzero value is
|
|
returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>12</em></td>
|
|
<td align="left" valign="top"><strong>Socket send buffer size -</strong>
|
|
Determine the size of the send buffer.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>13</em></td>
|
|
<td align="left" valign="top"><strong>Socket type value -</strong> Determine
|
|
the value for the socket type.
|
|
|
|
<table cellpadding="5">
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Stream type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Datagram type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Raw type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">Sequential packet type.</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Socket state.</strong> The current state of the socket.</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">Uninitialized</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Unbound</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Bound</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Listening</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">Connecting</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top">Connected</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>6</em></td>
|
|
<td align="left" valign="top">Disconnected</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>7</em></td>
|
|
<td align="left" valign="top">Error</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Task name.</strong> The task name as identified to the system.</p>
|
|
|
|
<p><strong>TCP state.</strong> A typical connection goes through the
|
|
states:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top">0</td>
|
|
<td valign="top">Listen, waiting for a connection request from any remote
|
|
host.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1</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">2</td>
|
|
<td align="left" valign="top">SYN-received, waiting for a confirming connection
|
|
request acknowledgement.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">3</td>
|
|
<td align="left" valign="top">Established, the normal state in which data is
|
|
transferred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">4</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">5</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">6</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">7</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">8</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">9</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">10</td>
|
|
<td align="left" valign="top">Closed, the connection has ended.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">11</td>
|
|
<td align="left" valign="top">State value not supported by protocol.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Total retransmissions.</strong> The total number of times the local
|
|
system retransmitted a segment because an acknowledgment was not received. This
|
|
is a cumulative count of all segments resent during the entire time the
|
|
connection has been active. This field is only valid for TCP connections.</p>
|
|
|
|
<p><strong>User send next.</strong> The sequence number of the next byte of
|
|
data to be sent by the client application. This field is only valid for TCP
|
|
connections.</p>
|
|
|
|
<p><strong>User receive next.</strong> The sequence number of the next byte to
|
|
be passed to the application by TCP.</p>
|
|
|
|
<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">TCP84C9 I</td>
|
|
<td align="left" valign="top">Information returned incomplete.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">TCP84CA E</td>
|
|
<td align="left" valign="top">Connection request parameter not valid.</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">CPF3C19 E</td>
|
|
<td align="left" valign="top">Error occurred with receiver variable
|
|
specified.</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">CPF3C24 E</td>
|
|
<td align="left" valign="top">Length of the receiver variable is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</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">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<br>
|
|
<br>
|
|
<hr>
|
|
API introduced: V5R1
|
|
|
|
<hr>
|
|
<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>
|
|
</body>
|
|
</html>
|
|
|