426 lines
12 KiB
HTML
426 lines
12 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>Trace Exit Program for Trace TCP/IP Application command</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 -->
|
||
|
|
<!-- Created for V5R3 by Sergio Toscano (stlomeli@mx1.ibm.com) -->
|
||
|
|
<!-- Change history -->
|
||
|
|
<!-- v5r3 New Exit Program -->
|
||
|
|
<!-- 030226 HTML cleanup by JET -->
|
||
|
|
<!-- REASON LEVEL DATE PGMR COMMENT -->
|
||
|
|
<!-- 3255.1 5D30 030509 STLOMELI Change link to Communications APIs -->
|
||
|
|
<!-- instead of WorkManagement APIs -->
|
||
|
|
<!-- 3255.2 5D30 030803 STLOMELI Add LIC Log identifier to -->
|
||
|
|
<!-- Comparison data parameter -->
|
||
|
|
<!-- 3602 5D40 041008 STLOMELI Add link to TRCTCPAPP -->
|
||
|
|
<!-- 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>Trace Exit Program for Trace TCP/IP Application command</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
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%">Trace option setting</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Application</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Error detected</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Comparison data<sup><a href=
|
||
|
|
"#note">1</a></sup></td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
QSYSINC/H member name: ESCWCHT<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p><strong><a name="note">Note 1</a>:</strong> Valid only when watch for trace
|
||
|
|
event facility is enabled (WCHMSG or WCHLICLOG parameters were specified)<br>
|
||
|
|
<br>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>The Trace TCP/IP Application (TRCTCPAPP) command has the capability to call a
|
||
|
|
user-written program, if specified in the TRCPGM parameter. This user written
|
||
|
|
program will be called in the following circumstances:</p>
|
||
|
|
|
||
|
|
<p>For SET(*ON), the trace program will be called:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Before the application trace starts.</li>
|
||
|
|
|
||
|
|
<li>After the communications and Licensed Internal Code (LIC) traces, if requested, start.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>For SET(*OFF), the trace program will be called:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Before the LIC traces, if requested, end.</li>
|
||
|
|
|
||
|
|
<li>After the communications trace, if requested, ends.</li>
|
||
|
|
|
||
|
|
<li>After the application trace ends.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>For SET(*END), the trace program will be called:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>After the LIC and communications traces, if requested, end.</li>
|
||
|
|
|
||
|
|
<li>After the application trace ends.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Also, the Trace TCP/IP Application (TRCTCPAPP) command has the capability to
|
||
|
|
watch for a specific event and end the trace when this event occurs. An event
|
||
|
|
can be a message being sent to a specific message queue, history log or job
|
||
|
|
log; or a LIClog. If specified in the TRCPGM parameter, the watch for trace
|
||
|
|
event facility will call a user-written program at the moments specified in the
|
||
|
|
Trace option setting parameter.</p>
|
||
|
|
|
||
|
|
<p>See the online help for more information on the TRCTCPAPP command.<br>
|
||
|
|
</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>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Trace option setting</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The reason indicating the moment at which the user-written program was
|
||
|
|
called. The possible values are:</p>
|
||
|
|
|
||
|
|
<table border>
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">*ON</td>
|
||
|
|
<td align="left" valign="top">- The collection of trace information is started,
|
||
|
|
or <br>
|
||
|
|
- The watch for trace facility is starting<sup>1</sup>.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td>*OFF</td>
|
||
|
|
<td>The collection of trace information is stopped and the trace information is
|
||
|
|
written to spooled printer files of the user. </td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td>*END</td>
|
||
|
|
<td>Tracing is ended and all trace information is deleted. No trace information
|
||
|
|
output is created.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td>*MSGID<sup>1</sup></td>
|
||
|
|
<td>A match on a message id specified on WCHMSG parameter occurred.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">*LICLOG<sup>1</sup></td>
|
||
|
|
<td align="left" valign="top">A match on a LIC log specified on the WCHLICLOG
|
||
|
|
parameter occurred.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td>*CMPDATA<sup>1</sup></td>
|
||
|
|
<td>The major and minor code of a LIC log matched, but the comparison data did
|
||
|
|
not.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td>*INTVAL<sup>1</sup></td>
|
||
|
|
<td>The time interval specified on TRCPGMITV parameter is elapsed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td>*WCHTIMO<sup>1</sup></td>
|
||
|
|
<td>The length of time to watch specified on WCHTIMO is elapsed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Application.</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The possible values for the "Application" parameter are the same as the
|
||
|
|
values for the APP parameter on the TRCTCPAPP command. Ignored by watch for
|
||
|
|
trace event facility.<br>
|
||
|
|
<br>
|
||
|
|
</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error detected</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>Indicates if the trace event facility should stop or continue running, or if
|
||
|
|
an error on the user-written program was found. The possible values are:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>*CONTINUE<sup>1</sup> - The trace and the watch for trace event facility.</li>
|
||
|
|
<li>*STOP<sup>1</sup> - The trace and the watch for trace event facility will be ended.</li>
|
||
|
|
<li>*ERROR - Error detected by customer trace program.</li>
|
||
|
|
</ul>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Comparison data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The format of the trace information depends on the Trace option setting
|
||
|
|
causing the exit program to be called. The format of the Comparison data is as
|
||
|
|
follows if the Trace option setting is *MSGID:</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%">Length of trace information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(7)</td>
|
||
|
|
<td align="left" valign="top">Message ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">11</td>
|
||
|
|
<td align="center" valign="top">B</td>
|
||
|
|
<td align="left" valign="top">CHAR(9)</td>
|
||
|
|
<td align="left" valign="top">Reserved</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">Offset to comparison data</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">Length of comparison data</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="center" valign="top">1C</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Message comparison data</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<p>The format of the Comparison data is as follows if the Trace option setting
|
||
|
|
is *LICLOG or *CMPDATA:</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%">Length of trace information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(4)</td>
|
||
|
|
<td align="left" valign="top">LIC Log major code</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">CHAR(4)</td>
|
||
|
|
<td align="left" valign="top">LIC Log minor code</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">LIC Log identifier</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">Offset to comparison data</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">Length of comparison data</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="center" valign="top">1C</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">LIC Log comparison data</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<p>The format of the Comparison data is as follows if the Trace option setting
|
||
|
|
is *ON, *INTVAL or *WCHTIMO:</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%">Length of trace information (always 4 at this
|
||
|
|
time)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="Header_9"></a>Field Descriptions</h3>
|
||
|
|
|
||
|
|
<p><strong>Length of trace information. </strong> The length of the
|
||
|
|
Comparison data parameter passed to the user-written exit program.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of comparison data. </strong> The length of the user
|
||
|
|
specified text to be compared against the event data.</p>
|
||
|
|
|
||
|
|
<p><strong>LIC Log identifier.</strong> The LIC Log entry identifier of the
|
||
|
|
LIC Log that occurred.</p>
|
||
|
|
|
||
|
|
<p><strong>LIC Log major code.</strong> The major code of the LIC Log that
|
||
|
|
occurred.</p>
|
||
|
|
|
||
|
|
<p><strong>LIC Log minor code.</strong> The minor code of the LIC Log that
|
||
|
|
occurred.</p>
|
||
|
|
|
||
|
|
<p><strong>LIC Log comparison data.</strong> The user specified text string
|
||
|
|
used to compare against the entry data of the watched for log entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Message ID. </strong> The identifier of the message that
|
||
|
|
occurred.</p>
|
||
|
|
|
||
|
|
<p><strong>Message comparison data.</strong> The user specified text string
|
||
|
|
used to compare against the entry data of the watched for message ID.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset to comparison data. </strong> The offset to the field
|
||
|
|
that holds the comparison data.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<p>See the <a href="../cl/trctcpapp.htm">Trace TCP/IP Application</a> (TRCTCPAPP) command
|
||
|
|
for more information.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
Exit program introduced: V5R3
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|