TCPLOG (JANUS DEFINE parameter): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (remove displaytitle)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:TCPLOG}}
<span class="pageSubtitle">TCPLOG filename &mdash; Log TCP activity to flatfile</span>
<span class="pageSubtitle"><section begin="desc" />TCPLOG filename &mdash; log TCP activity to flatfile.<section end="desc" /></span>


<var>TCPLOG</var> is a parameter on <var>[[JANUS DEFINE]]</var>, which defines and sets characteristics of a Janus port.  
<var>TCPLOG</var> is a parameter on <var>[[JANUS DEFINE]]</var>, which defines and sets characteristics of a Janus port.  
Line 8: Line 7:
The log file is opened and cleared when the associated Janus port is started, and it is closed when the port is stopped or if an error occurs writing data to the dataset.  
The log file is opened and cleared when the associated Janus port is started, and it is closed when the port is stopped or if an error occurs writing data to the dataset.  


The log data is written in variable length blocks. The first four bytes of a block contain the length of the block. Each block contains at least one record. No character translation or formatting is done for the actual TCP data. Since the blocks are standard variable length blocks, they all start with a Block Descriptor Word or BDW which consists of a halfword block length followed by two bytes of zero.  
The log data is written in variable length blocks. The first four bytes of a block contain the length of the block. Each block contains at least one record. No character translation or formatting is done for the actual TCP data. Since the blocks are standard variable length blocks, they all start with a Block Descriptor Word (BDW) which consists of a halfword block length followed by two bytes of zero.  


The layout of the records in each block is described in detail below:
The layout of the records in each block is described in detail below:


<table>
<table>
<tr><th style="text-align:right">Offset</th><th style="text-align:right">Length</th><th>Type</th><th>Description</th></tr>
<tr class="head"><th>Offset</th><th>Length</th><th>Type</th><th>Description</th></tr>
 
<tr><td style="text-align:right">0</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>RDW (Record descriptor word): the length of the current record</td></tr>
<tr><td style="text-align:right">0</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>RDW (Record descriptor word): the length of the current record</td></tr>
<tr><td style="text-align:right">2</td><td style="text-align:right">2</td><td>Unused</td><td>Unused</td></tr>
<tr><td style="text-align:right">2</td><td style="text-align:right">2</td><td>Unused</td><td>Unused</td></tr>
<tr><td style="text-align:right">4</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Unique TCP connection number</td></tr>
<tr><td style="text-align:right">4</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Unique TCP connection number</td></tr>
<tr><td style="text-align:right">12</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Time of day in clock units</td></tr>
 
<tr><td style="text-align:right">20</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Remote IP address</td></tr>
<tr><td style="text-align:right">12</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Record number</td></tr>
<tr><td style="text-align:right">24</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Local IP address</td></tr>
 
<tr><td style="text-align:right">28</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Remote port number</td></tr>
<tr><td style="text-align:right">16</td><td style="text-align:right">8</td><td>Unsigned binary</td><td>Time of day in clock units</td></tr>
<tr><td style="text-align:right">30</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Local port number</td></tr>
 
<tr><td style="text-align:right">32</td><td style="text-align:right">1</td><td>EBCDIC character</td><td>Direction: S (Sent) or R (Received)</td></tr>
<tr><td style="text-align:right">24</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Remote IP address</td></tr>
<tr><td style="text-align:right">33</td><td style="text-align:right">1</td><td>Unused</td><td>Unused</td></tr>
 
<tr><td style="text-align:right">34</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Length of TCP data</td></tr>
<tr><td style="text-align:right">28</td><td style="text-align:right">4</td><td>Unsigned binary</td><td>Local IP address</td></tr>
<tr><td style="text-align:right">36</td><td style="text-align:right">v</td><td>Binary</td><td>Any TCP data</td></tr>
 
<tr><td style="text-align:right">32</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Remote port number</td></tr>
 
<tr><td style="text-align:right">34</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Local port number</td></tr>
 
<tr><td style="text-align:right">36</td><td style="text-align:right">1</td><td>EBCDIC character</td><td>Direction: S (Sent) or R (Received)</td></tr>
 
<tr><td style="text-align:right">37</td><td style="text-align:right">1</td><td>Unused</td><td>Unused</td></tr>
 
<tr><td style="text-align:right">38</td><td style="text-align:right">2</td><td>Unsigned binary</td><td>Length of TCP data</td></tr>
 
<tr><td style="text-align:right">40</td><td style="text-align:right">v</td><td>Binary</td><td>Any TCP data</td></tr>
</table>
</table>
The <var>TCPLOG</var> dataset '''cannot''' be shared by multiple Janus ports.  
The <var>TCPLOG</var> dataset '''cannot''' be shared by multiple Janus ports.  


The <var>TCPLOG</var> parameter is valid only for <var>[[JANUS DEFINE#type|WEBSERV]]</var> ports.  
The <var>TCPLOG</var> parameter is valid only for <var>[[JANUS DEFINE#type|WEBSERV]]</var> ports.  
This parameter was introduced in ''[[Sirius Mods]]'' version 7.2.


==See also==
==See also==

Latest revision as of 00:08, 8 June 2016

TCPLOG filename — Log TCP activity to flatfile

TCPLOG is a parameter on JANUS DEFINE, which defines and sets characteristics of a Janus port.

A Janus Web Server port definition parameter, TCPLOG tells Janus Web Server to log in a sequential dataset all inbound and outbound TCP data transmitted for this port. The dataset name is specified as the value that follows the TCPLOG keyword.

The log file is opened and cleared when the associated Janus port is started, and it is closed when the port is stopped or if an error occurs writing data to the dataset.

The log data is written in variable length blocks. The first four bytes of a block contain the length of the block. Each block contains at least one record. No character translation or formatting is done for the actual TCP data. Since the blocks are standard variable length blocks, they all start with a Block Descriptor Word (BDW) which consists of a halfword block length followed by two bytes of zero.

The layout of the records in each block is described in detail below:

OffsetLengthTypeDescription
02Unsigned binaryRDW (Record descriptor word): the length of the current record
22UnusedUnused
48Unsigned binaryUnique TCP connection number
124Unsigned binaryRecord number
168Unsigned binaryTime of day in clock units
244Unsigned binaryRemote IP address
284Unsigned binaryLocal IP address
322Unsigned binaryRemote port number
342Unsigned binaryLocal port number
361EBCDIC characterDirection: S (Sent) or R (Received)
371UnusedUnused
382Unsigned binaryLength of TCP data
40vBinaryAny TCP data

The TCPLOG dataset cannot be shared by multiple Janus ports.

The TCPLOG parameter is valid only for WEBSERV ports.

See also