161 lines
4.5 KiB
HTML
161 lines
4.5 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>mkDPIclose()--Make a DPI Close Packet</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
|
<!-- 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. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- Edited by Kersten Feb 02 -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
|
|
<!--Java sync-link-->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2>mkDPIclose()--Make a DPI Close Packet</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <qtossapi.h>
|
|
|
|
unsigned char *mkDPIclose( char <em>reason_code</em> );
|
|
|
|
</pre>
|
|
|
|
<br>
|
|
Service Program Name: QTOSSAPI<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>mkDPIclose()</strong> function makes a DPI close packet and
|
|
returns a pointer to the packet.</p>
|
|
|
|
<br>
|
|
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
<dt><strong>reason_code</strong></dt>
|
|
|
|
<dd>(Input) The reason for the close. See the <strong>
|
|
<qtossapi.h></strong> file in the QSYSINC library for the list of defined
|
|
reason codes.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Return Value</h3>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>value</em></td>
|
|
<td align="left" valign="top">The value returned is a pointer to the DPI
|
|
packet.
|
|
|
|
<p>If successful, then a pointer to a static DPI packet buffer is returned. The
|
|
first 2 bytes of the buffer (in network byte order) contain the length of the
|
|
remaining packet. The <strong>DPI_PACKET_LEN()</strong> function can be used to
|
|
calculate the total length of the DPI packet.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>NULL</em></td>
|
|
<td align="left" valign="top">If unsuccessful, then a NULL pointer is
|
|
returned.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>Be aware that the static buffer for the DPI packet is shared by other
|
|
mkDPI<em>xxxx</em>() functions that create a serialized DPI packet.</p>
|
|
|
|
<p>For more information, see "SNMP Subagent Problem Determination" in the <a
|
|
href="../books/sc415412.pdf" target="_blank">Simple Network Management
|
|
Protocol (SNMP) Support</a> <img src="wbpdf.gif" alt="Link to PDF">book.</p>
|
|
|
|
<br>
|
|
<h3>Usage Notes</h3>
|
|
|
|
<p>The <strong>mkDPIclose()</strong> function creates a serialized DPI CLOSE
|
|
packet that can then be sent to the DPI peer. As a result of sending the
|
|
packet, the DPI connection will be closed.</p>
|
|
|
|
<p>Sending a DPI CLOSE packet to the agent implies an automatic DPI UNREGISTER
|
|
for all registered subtrees on the connection being closed.</p>
|
|
|
|
<br>
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li>The <<strong>qtossapi.h</strong>> file (see <a href="unix13.htm">
|
|
Header Files for UNIX-Type Functions</a>)<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li><a href="dlensnmp.htm">DPI_PACKET_LEN()</a>--Get Length of DPI Packet</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<h3>Example</h3>
|
|
|
|
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
|
|
for information pertaining to code examples.</p>
|
|
|
|
<pre>
|
|
#include <qtossapi.h>
|
|
unsigned char *pack_p;
|
|
|
|
pack_p = mkDPIclose(SNMP_CLOSE_goingDown);
|
|
if (pack_p) {
|
|
/* Send the packet to the agent. */
|
|
}
|
|
|
|
</pre>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V3R6
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|