friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qtocccna.htm

577 lines
16 KiB
HTML
Raw Permalink Blame History

<!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>Change Connection Attribute (QTOCCCNA) API</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- COMM4 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB at -->
<!-- RCHVMW2 on 1 Jun 1999 at 17:32:50 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- 050512 SGLEZ Add new V5R4 IPv6 formats -->
<!--File Edited May, 2005 =========================================== -->
<!--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>Change Connection Attribute (QTOCCCNA) API</h2>
<div class="box" style="width: 60%;">
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top">1</td>
<td align="left" valign="top" width="50%">Change information</td>
<td align="left" valign="top" width="20%">Input</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 change information</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">Change information format</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">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>Change Connection Attribute (QTOCCCNA)</strong> API can change
the attribute of a socket or connection directly. A valid socket descriptor is
not required. Instead, the socket or connection to be changed is identified by
specifying the associated port and IP address information.</p>
<p>The SO_DEBUG socket option is the only attribute that can be changed.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Default public authority</em></dt>
<dd>*EXCLUDE.</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Change information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The socket or connection that is changed.</p>
</dd>
<dt><strong>Change information format</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the change information input data. The possible values
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>TCPA0001</em></td>
<td align="left" valign="top">Change the connection attribute of a connection.
The connection is identified by specifying the local and remote values for the
IP address and port number. See <a href="#format_tcpa0001">TCPA0001 Format</a>
below.</td>
</tr>
<tr>
<td align="left" valign="top"><em>UDPA0001</em></td>
<td align="left" valign="top">Change the connection attribute of a socket. The
socket is identified by specifying its local IP address and local port number.
See <a href="#format_udpa0001">UDPA0001 Format</a> below.</td>
</tr>
<tr>
<td align="left" valign="top">
<img src="delta.gif" alt="Start of change"><em>TCPA0101</em></td>
<td align="left" valign="top">Change the connection attribute of a connection.
The connection is identified by specifying the local and remote values for the
IPv6 address and port number. See <a href="#format_tcpa0101">TCPA0101 Format</a>
below.</td>
</tr>
<tr>
<td align="left" valign="top"><em>UDPA0101</em></td>
<td align="left" valign="top">Change the connection attribute of a socket. The
socket is identified by specifying its local IPv6 address and local port number.
See <a href="#format_udpa0101">UDPA0101 Format</a> below.
<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
</dd>
<dt><strong>Length of change information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The total length in bytes of the change information input variable.</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>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<br>
<h3><a name="format_tcpa0001">TCPA0001 Format</a></h3>
<p>Use this format when changing a connection. For detailed descriptions of the
fields in this table, see <a href="#IPv4_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%">Attribute to change</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">Attribute value</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 IP address binary</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">Local port number</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 IP address binary</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">Remote port number</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="format_udpa0001">UDPA0001 Format</a></h3>
<p>Use this format when changing a socket. For detailed descriptions of the
fields in this table, see <a href="#IPv4_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%">Attribute to change</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">Attribute value</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 IP address binary</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">Local port number</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="IPv4_FIELD">Field Descriptions</a></h3>
<p><strong>Attribute to change.</strong> The possible value is:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Change the debug attribute (SO_DEBUG socket
option) of the connection.</td>
</tr>
</table>
<p><strong>Attribute value.</strong> Possible values are:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The debug attribute is not set.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The debug attribute is set.</td>
</tr>
</table>
<p><strong>Local IP address.</strong> The local internet address used by the
connection in binary form.</p>
<p><strong>Local port number.</strong> The local system port number used by the
connection.</p>
<p><strong>Remote IP address.</strong> The remote internet address used by the
connection in binary form.</p>
<p><strong>Remote port number.</strong> The remote system port number used by
the connection.</p>
<br>
<h3><img src="delta.gif" alt="Start of change"><a name="format_tcpa0101">TCPA0101 Format</a></h3>
<p>Use this format when changing an IPv6 connection. For detailed descriptions of the
fields in this table, see <a href="#IPv6_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%">Attribute to change</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">Attribute value</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Local IPv6 address binary</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</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">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Remote IPv6 address binary</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</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">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="format_udpa0101">UDPA0101 Format</a></h3>
<p>Use this format when changing an IPv6 socket. For detailed descriptions of the
fields in this table, see <a href="#IPv6_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%">Attribute to change</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">Attribute value</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Local IPv6 address binary</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</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">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="IPv6_FIELD">Field Descriptions</a></h3>
<p><strong>Attribute to change.</strong> The possible value is:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Change the debug attribute (SO_DEBUG socket
option) of the connection.</td>
</tr>
</table>
<p><strong>Attribute value.</strong> Possible values are:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The debug attribute is not set.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The debug attribute is set.</td>
</tr>
</table>
<p><strong>Local IPv6 address.</strong> The local IPv6 address used by the
connection in binary form.</p>
<p><strong>Local port number.</strong> The local system port number used by the
connection.</p>
<p><strong>Remote IPv6 address.</strong> The remote IPv6 address used by the
connection in binary form.</p>
<p><strong>Remote port number.</strong> The remote system port number used by
the connection.<img src="deltaend.gif" alt="End of change"></p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF3C17 E</td>
<td width="85%" valign="top">Error occurred with input data parameter.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</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">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">TCP3842 E</td>
<td align="left" valign="top">Error processing internal data request.</td>
</tr>
<tr>
<td align="left" valign="top">TCP3B03 E</td>
<td align="left" valign="top">Connection &amp;1:&amp;2, &amp;3:&amp;4, not found.</td>
</tr>
<tr>
<td align="left" valign="top">TCP3B04 E</td>
<td align="left" valign="top">Socket &amp;1:&amp;2, &amp;3:&amp;4, not found.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C0 E</td>
<td align="left" valign="top">TCP/IP stack not active.</td>
</tr>
<tr>
<td align="left" valign="top">TCP8A0B E</td>
<td align="left" valign="top">IPv6 internal error - &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">TCP923F E</td>
<td align="left" valign="top">Value for parameter &amp;2 for API &amp;1 not valid.</td>
</tr>
</table>
<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>
Reference in New Issue View Git Blame Copy Permalink