198 lines
5.8 KiB
HTML
198 lines
5.8 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>mkDPItrap()--Make a DPI Trap Packet</title>
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- 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 -->
|
||
|
|
<!--End Header Records -->
|
||
|
|
<!-- Edited by Kersten Feb 02 -->
|
||
|
|
<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>mkDPItrap()--Make a DPI Trap Packet</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <qtossapi.h>
|
||
|
|
|
||
|
|
unsigned char *mkDPItrap(
|
||
|
|
long int <em>generic</em>,
|
||
|
|
long int <em>specific</em>,
|
||
|
|
snmp_dpi_set_packet <em>*packet_p</em>,
|
||
|
|
char <em>*enterprise_p</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>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<p>The <strong>mkDPItrap()</strong> function makes a DPI trap 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>generic</strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) The generic trap type. The range of this value is 0 through 6,
|
||
|
|
where 6 (enterpriseSpecific) is the type that is probably used most by DPI
|
||
|
|
subagent programmers. The values 0 through 5 are well-defined standard SNMP
|
||
|
|
traps.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>specific</strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) The (enterprise) specific trap type. This can be any value that is
|
||
|
|
valid for the Management Information Base (MIB) subtrees that the subagent
|
||
|
|
implements.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>packet_p</strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) A pointer to a chain of snmp_dpi_set_structures that represents the
|
||
|
|
varbinds to be passed with the trap. This partial structure will be freed by
|
||
|
|
the mkDPItrap() function; therefore, you cannot refer to it anymore on
|
||
|
|
completion of the call. A NULL pointer means that there are no varbinds to be
|
||
|
|
included in the trap.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>enterprise_p</strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) A pointer to a NULL-terminated character string that represents the
|
||
|
|
enterprise ID (OBJECT IDENTIFIER) for which this trap is defined. A NULL
|
||
|
|
pointer can be used. In this case, the subagent Identifier as passed in the DPI
|
||
|
|
OPEN packet will be used when the agent receives the DPI TRAP packet.
|
||
|
|
|
||
|
|
<p><strong>Note</strong>: This OID must not end in a period (.).</p>
|
||
|
|
</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</a> <img src="wbpdf.gif" alt="Link to PDF"> book.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<p>The <strong>mkDPItrap()</strong> function is used at the subagent side to
|
||
|
|
prepare a DPI TRAP packet. The resulting packet can be sent to the SNMP
|
||
|
|
agent.</p>
|
||
|
|
|
||
|
|
<p>Unnecessary free operations may result in an MCH6902 (type 2). If this
|
||
|
|
occurs, remove the call to <strong>fDPIset()</strong>.</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;
|
||
|
|
snmp_dpi_set_packet *set_p;
|
||
|
|
long int num;
|
||
|
|
|
||
|
|
set_p = mkDPIset(snmp_dpi_set_packet_NULL_p,
|
||
|
|
"1.3.6.1.2.3.4.5.", "1.0",
|
||
|
|
SNMP_TYPE_Integer32,
|
||
|
|
sizeof(num), &num);
|
||
|
|
if (set_p) {
|
||
|
|
pack_p = mkDPItrap(6,1,set_p, (char *)0);
|
||
|
|
if (pack_p) {
|
||
|
|
/* Send packet to subagent. */
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|