TCPLOG (JANUS DEFINE parameter)

From m204wiki
Revision as of 16:15, 14 March 2011 by Alan (talk | contribs)
Jump to navigation Jump to search

<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.

The layout of a block and record is described in detail below:

Offset Length Type Description ------ ------ --------------- ----------------------------------- 0-3 4 Unsigned binary BDW (Block descriptor word): the length of the block 4-5 2 Unsigned binary RDW (Record descriptor word): the length of the current record 6-7 2 Unused 8-15 8 Unsigned binary Unique TCP connection number 16-23 8 Unsigned binary Time of day in clock units 24-27 4 Unsigned binary Remote IP address 28-31 4 Unsigned binary Local IP address 32-33 2 Unsigned binary Remote port number 34-35 2 Unsigned binary Local port number 36-36 1 EBCDIC character Direction: S (Sent) or R (Received) 37-37 1 Unused 38-39 2 Unsigned binary Length of TCP data 39-n v Any 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.

References

See: List of Janus commands | List of JANUS DEFINE parameters.