TCPLOG (JANUS DEFINE parameter): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />TCPLOG filename -- log TCP activity to flatfile.<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />TCPLOG filename -- log TCP activity to flatfile.<section end="desc" /></span>


TCPLOG is a parameter on [[JANUS DEFINE]], which defines and sets characteristics of a Janus port. See the [[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]].
<var>TCPLOG</var> is a parameter on <var>[[JANUS DEFINE]]</var>, which defines and sets characteristics of a Janus port. See the [[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]].


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 <code>TCPLOG</code> keyword.  
A <var class="product">[[Janus Web Server]]</var> port definition parameter, <var>TCPLOG</var> tells <var class="product">Janus Web Server</var> 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 <code>TCPLOG</code> 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 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 <var>BDW</var> 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 or 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:
Line 27: Line 27:
<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">36</td><td style="text-align:right">v</td><td>Binary</td><td>Any TCP data</td></tr>
</table>
</table>
The TCPLOG dataset '''cannot''' be shared by multiple Janus ports.  
The <var>TCPLOG</var> dataset '''cannot''' be shared by multiple Janus ports.  


The TCPLOG parameter is valid only for WEBSERV ports.  
The <var>TCPLOG</var> parameter is valid only for WEBSERV ports.  


This parameter was introduced in ''[[Sirius Mods]]'' version 7.2.
This parameter was introduced in ''[[Sirius Mods]]'' version 7.2.


==References==
==See also==
<ul>
<li>[[List of Janus commands]]
<li>[[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]]
</ul>


See: [[List of Janus commands]] | [[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]].


[[Category:JANUS DEFINE parameters|TCPLOG]]
[[Category:JANUS DEFINE parameters|TCPLOG]]

Revision as of 18:11, 28 February 2012

<section begin="desc" />TCPLOG filename -- log TCP activity to flatfile.<section end="desc" />

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

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 or 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
128Unsigned binaryTime of day in clock units
204Unsigned binaryRemote IP address
244Unsigned binaryLocal IP address
282Unsigned binaryRemote port number
302Unsigned binaryLocal port number
321EBCDIC characterDirection: S (Sent) or R (Received)
331UnusedUnused
342Unsigned binaryLength of TCP data
36vBinaryAny TCP data

The TCPLOG dataset cannot be shared by multiple Janus ports.

The TCPLOG parameter is valid only for WEBSERV ports.

This parameter was introduced in Sirius Mods version 7.2.

See also