OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/J
TP1/Client/J outputs UAP trace information to the directory specified in the TrcPath argument of the setUapTraceMode method or the directory specified in the dcuaptracepath operand of the TP1/Client/J environment definition; the file names are DCUAP1.TRC and DCUAP2.TRC. You specify the file size with the size argument of the setUapTraceMode method or the dcuaptracesize operand of the TP1/Client/J environment definition.
For a UAP trace, TP1/Client/J collects the following information at the start and end of the method provided by TP1/Client/J:
If the transferred data exceeds 60 bytes, only the first 60 bytes of data are obtained.
The output format of a UAP trace file is as follows:
yyyy/mm/dd hh:mm:ss.uuu Location = lll ThreadName = ttt MethodName = nnnnnnnnnnnnnnnnnnnn Exception = eeeeeeeeeeeeeeeeeeee ADDRESS +0 +1 +2 +3 +4 +5 +6 +7 +8 +9 +a +b +c +d +e +f 0123456789abcdef 00000000 73 61 69 73 70 70 00 00 00 00 00 00 00 00 00 00 saispp.......... 00000010 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ 00000020 73 61 69 73 76 72 30 31 00 00 00 00 00 00 00 00 saisvr01........ : : :
The information that is output depends on the method and collection timing. The following tables show the information that is output for each method.
Table 2-9 Information for the openConnection() method and the openConnection(host, port) method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Connection-target host name | 0 | 0 | 64 | Connection-target host name specified in the argument. If the argument is not specified, this information is not collected, in which case this field is cleared to zeros. |
Connection-target port number | 40 | 64 | 4 | Connection-target port number specified in the argument. If the argument is not specified, this information is not collected, in which case a UAP trace is obtained with -1 set. |
|
Maximum time of inquiry interval | 44 | 68 | 4 | Maximum time of inquiry interval used during method execution. This is the value specified in the dccltinquiretime operand of the TP1/Client/J environment definition or in the setDccltinquiretime method. |
|
Maximum time to wait for a response | 48 | 72 | 4 | Maximum time to wait for a response during method execution. This is the value specified in the dcwatchtim operand of the TP1/Client/J environment definition or in the setDcwatchtim method. |
|
Input stream checking interval | 4C | 76 | 4 | Input stream checking interval used during method execution. This is the value specified in the dcselint operand of the TP1/Client/J environment definition or in the setDcselint method. |
|
Exit point | Performance analysis trace identification information | 0 | 0 | 26 | Performance analysis trace identification information |
Table 2-10 Information for the openConnection(url, flags) method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Connection destination URL | 0 | 0 | 128 | TP1/Web URL specified by the url parameter. |
Option flags | 0 | 0 | 2 | Value specified by the openConnection flags parameter. The following value is set:
|
|
Maximum time to wait for a response | 0 | 0 | 4 | The maximum time to wait for a response specified by the setDcwatchtim method. | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-11 Information for the rpcCall method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Service group name | 0 | 0 | 32 | Service group name of the called service |
Service name | 20 | 32 | 32 | Name of the called service | |
Send data length | 40 | 64 | 4 | Length of send data | |
Send data | 44 | 68 | 60 | Data to be sent | |
Receive data length | 80 | 128 | 4 | Length of data to be received | |
Option flag | 84 | 132 | 4 | Value specified for the flags argument of the rpcCall method. One of the following values is set:
|
|
Maximum time to wait for a response | 88 | 136 | 4 | Maximum time to wait for a response during method execution. This is the value specified in the dcwatchtim operand of the TP1/Client/J environment definition or in the setDcwatchtim method. |
|
Server communication delay time | 8C | 140 | 4 | Server communication delay time used during method execution. This is the value specified in the dccltdelay operand of the TP1/Client/J environment definition or in the setDccltdelay method. 0 is set if the remote API facility is not used. |
|
Input stream checking interval | 90 | 144 | 4 | Input stream checking interval used during method execution. This is the value specified in the dcselint operand of the TP1/Client/J environment definition or in the setDcselint method. |
|
Exit point# | Receive data length | 0 | 0 | 4 | Length of the received response |
Receive data | 4 | 4 | 60 | Received data | |
Performance analysis trace identification information | 40 | 64 | 26 | Performance analysis trace identification information |
#: In the case of a no-response-type service request, the exit point information consists of performance analysis trace identification information only.
Table 2-12 Information for the rpcCallTo method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Connection-target host name | 0 | 0 | 64 | Target host name used during method execution. This is the value specified in DCRpcBindTbl. |
Connection-target port number | 40 | 64 | 4 | Port number of the target host that was used during method execution. This is the value specified in DCRpcBindTbl. |
|
Connection-target option flag | 44 | 68 | 4 | Communication protocol flag of the rpcCallTo method:
|
|
Service group name | 48 | 72 | 32 | Service group name of the called service | |
Service name | 68 | 104 | 32 | Name of the called service | |
Send data length | 88 | 136 | 4 | Length of send data | |
Send data | 8C | 140 | 60 | Data to be sent | |
Receive data length | C8 | 200 | 4 | Length of data to be received | |
Option flag | CC | 204 | 4 | Value specified in the flags argument of the rpcCallTo method. One of the following values is set:
|
|
Maximum time to wait for a response | D0 | 208 | 4 | Maximum time to wait for a response during method execution. This is the value specified in the dcwatchtim operand of the TP1/Client/J environment definition or in the setDcwatchtim method. |
|
Server communication delay time | D4 | 212 | 4 | Server communication delay time used during method execution. This is the value specified in the dccltdelay operand of the TP1/Client/J environment definition or in the setDccltdelay method. 0 is set if the remote API facility is not used. |
|
Input stream checking interval | D8 | 216 | 4 | Input stream checking interval used during method execution. This is the value specified in the dcselint operand of the TP1/Client/J environment definition or in the setDcselint method. |
|
Exit point# | Receive data length | 0 | 0 | 4 | Length of the received response |
Receive data | 4 | 4 | 60 | Received data | |
Performance analysis trace identification information | 40 | 64 | 26 | Performance analysis trace identification information |
#: In the case of a no-response-type service request, the exit point information consists of performance analysis trace identification information only.
Table 2-13 Information for the closeConnection method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Maximum time to wait for a response | 0 | 0 | 4 | Maximum time to wait for a response during method execution. This is the value specified in the dcwatchtim operand of the TP1/Client/J environment definition or in the setDcwatchtim method. |
Input stream checking interval | 4 | 4 | 4 | Input stream checking interval used during method execution. This is the value specified in the dcselint operand of the TP1/Client/J environment definition or in the setDcselint method. |
|
Exit point | Performance analysis trace identification information | 0 | 0 | 26 | Performance analysis trace identification information |
Table 2-14 Information for the setDcwatchtim method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Maximum time to wait for a response | 0 | 0 | 4 | Maximum time to wait for a response |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-15 Information for the setDccltinquiretime method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Maximum time of inquiry interval | 0 | 0 | 4 | Maximum value of inquiry interval |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-16 Information for the setDccltdelay method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Server communication delay time | 0 | 0 | 4 | Server communication delay time |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-17 Information for the setDcselint method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Input stream checking interval | 0 | 0 | 4 | Input stream checking interval |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-18 Information for the setDccltextend method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Level of extended facility | 0 | 0 | 4 | Extension level of the TP1/Client/J facility |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-19 Information for the setRpcextend method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Level of RPC extended facility | 0 | 0 | 4 | Extension level of the RPC facility of TP1/Client/J. Disjunction of the following values is set:
|
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-20 Information for the setDchost method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Connection-target host name | 0 | 0 | 64 | Host name specified in the host argument |
Connection-target port number | 40 | 64 | 4 | Port number specified in the port argument | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-21 Information for the rpcOpen method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Name of the TP1/Client/J environment definition file | 0 | 0 | 256 | TP1/Client/J environment definition file name specified in the deffilename argument. If the argument is not specified, this information is not collected, in which case this field is cleared to zeros. |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-22 Information for the trnBegin method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Expiry time in transaction branch | 0 | 0 | 4 | Value specified in the dcclttrexptm operand of the TP1/Client/J environment definition |
Transaction branch CPU monitoring interval | 4 | 4 | 4 | Value specified in the dcclttrcputm operand of the TP1/Client/J environment definition | |
Object of transaction branch monitoring interval | 8 | 8 | 1 | Value specified in the dcclttrexpsp operand of the TP1/Client/J environment definition:
|
|
Statistical information collection item | 9 | 9 | 4 | Value specified in the dcclttrstatisitem operand of the TP1/Client/J environment definition:
|
|
Transaction optimization item | D | 13 | 4 | Value specified in the dcclttroptiitem operand of the TP1/Client/J environment definition:
|
|
Maximum communication wait time during transaction synchronization point processing | 11 | 17 | 4 | Value specified in the dcclttrwatchtime operand of the TP1/Client/J environment definition | |
Value for rollback information acquisition | 15 | 21 | 4 | Value specified in the dcclttrrbinfo operand of the TP1/Client/J environment definition:
|
|
Maximum executable value for transaction branch | 19 | 25 | 4 | Value specified in the dcclttrlimittime operand of the TP1/Client/J environment definition | |
Value for rollback completion report | 1D | 29 | 4 | Value specified in the dcclttrrbrcv operand of the TP1/Client/J environment definition:
|
|
Value for synchronization point processing method in the event of a UAP error | 21 | 33 | 4 | Value specified in the dcclttrrecoverytype operand of the TP1/Client/J environment definition:
|
|
Exit point | Performance analysis trace identification information | 0 | 0 | 26 | Performance analysis trace identification information |
Table 2-23 Information for the trnInfo method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | None | N/A | N/A | N/A | N/A |
Exit point | Under-transaction flag | 0 | 0 | 1 |
|
N/A: Not applicable
Table 2-24 Information for the getTrnID method
Collection location | Item | Location | Length (bytes) |
Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | None | N/A | N/A | N/A | N/A |
Exit point | Transaction global identifier | 0 | 0 | 16 | This information is acquired only if the method terminates normally. |
Transaction branch identifier | 10 | 16 | 16 | This information is acquired only if the method terminates normally. |
N/A: Not applicable
Table 2-25 Information for the cltReceive method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Receive data length | 0 | 0 | 4 | Length of data to be received |
Timeout set time | 4 | 4 | 4 | Time interval specified for timeout | |
Option flags | 8 | 8 | 4 | Value specified by the flags parameter of the cltReceive method. One of the following values is set:
|
|
Exit point | Receive data length | 0 | 0 | 4 | Length of data to be received |
Receive data | 4 | 4 | 60 | Received data |
Table 2-26 Information for the cltSend method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Send data | 0 | 0 | 60 | Data to be sent |
Send data length | 3C | 60 | 4 | Length of data to be sent | |
Name of connected host | 40 | 64 | 64 | Name of remote host specified by the hostname parameter. | |
Connection destination port number | 80 | 128 | 4 | Port number of remote system specified by the portnum parameter. | |
Option flags | 84 | 132 | 4 | Value specified by the flags parameter of the cltSend method. One of the following values is set:
|
|
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-27 Information for the cltAssemSend method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Send data | 0 | 0 | 60 | Data to be sent |
Send data length | 3C | 60 | 4 | Length of data to be sent | |
Name of connected host | 40 | 64 | 64 | Name of remote host specified by the hostname parameter. | |
Connection destination port number | 80 | 128 | 4 | Port number of remote system specified by the portnum parameter. | |
Time-out setting | 84 | 132 | 4 | Time-out setting | |
Option flags | 88 | 136 | 4 | Value specified by the flags parameter of the cltAssemSend method. One of the following values is set:
|
|
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-28 Information for the cltAssemReceive method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Time-out setting | 0 | 0 | 4 | Time-out setting |
Option flags | 4 | 4 | 4 | Value specified by the flags parameter of the cltAssemReceive method. One of the following values is set:
|
|
Exit point | Receive data length | 0 | 0 | 4 | Length of response received |
Receive data | 4 | 4 | 60 | Received data |
Table 2-29 Information for the setConnectInformation method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Logical terminal name of the DCCM3 logical terminal | 0 | 0 | 64 | Logical terminal name of the DCCM3 logical terminal, as specified in the inf parameter |
Length of terminal identification information | 40 | 64 | 2 | Length of terminal identification information, as specified in the inf_len parameter | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-30 Information for the acceptNotification method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Length of area for storing a notification message from the server | 0 | 0 | 4 | Length of area for storing a notification message from the server, as specified in the inf_len parameter |
Port number for receiving a notification message from the server | 4 | 4 | 4 | Port number for receiving a notification message from the server, as specified in the port parameter | |
Timeout value | 8 | 8 | 4 | Timeout value specified in the timeout parameter | |
Exit point | Notification message from the server | 0 | 0 | 60 | Notification message from the server that was stored in the inf parameter |
Length of notification message from the server | 3C | 60 | 4 | Length of notification message from the server, as specified in the inf_len argument | |
Host name of the server | 40 | 64 | 64 | Server's host name stored in the hostname parameter | |
Node identifier of the server | 80 | 128 | 8 | Server's node identifier specified in the nodeid parameter |
Table 2-31 Information for the cancelNotification method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Message to be sent to CUP | 0 | 0 | 60 | Message to be sent to the CUP, as specified in the inf parameter |
Length of message to be sent to CUP | 3C | 60 | 4 | Length of the message to be sent to CUP, as specified in the inf_len parameter | |
Host name of CUP waiting to receive unidirectional message | 40 | 64 | 64 | Host name of the CUP waiting to receive the unidirectional message, as specified in the hostname parameter | |
Port number of CUP waiting to receive unidirectional message | 80 | 128 | 4 | Port number of the CUP waiting to receive the unidirectional message, as specified in the port parameter | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-32 Information for the openNotification method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Port number for receiving a notification message from the server | 0 | 0 | 4 | Port number for receiving a notification message from the server, as specified in the port parameter |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-33 Information for the acceptNotificationChained method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Length of area for storing a notification message from the server | 0 | 0 | 4 | Length of area for storing a notification message from the server, as specified in the inf_len parameter |
Timeout value | 4 | 4 | 4 | Timeout value specified in the timeout parameter | |
Exit point | Notification message from the server | 0 | 0 | 60 | Notification message from the server, as stored in the inf parameter |
Length of notification message from the server | 3C | 60 | 4 | Length of the notification message from the server, as specified in the inf_len argument | |
Host name of the server | 40 | 64 | 64 | Server's host name stored in the hostname argument | |
Node identifier of the server | 80 | 128 | 8 | Server's node identifier specified in the nodeid parameter |
Table 2-34 Information for the setUapTraceMode method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | UAP trace output directory | 0 | 0 | 256 | UAP trace output directory specified in the TrcPath parameter |
Size of UAP trace file to be output | 100 | 256 | 4 | Size of the output UAP trace file, as specified in the size parameter | |
Flag indicating whether or not UAP trace is to be acquired | 104 | 260 | 4 | Flag indicating whether or not UAP trace is to be acquired, as specified in the flag parameter (if the flag parameter is set to true, 1 is output; if it is set to false, 0 is output) | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-35 Information for the setErrorTraceMode method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Error trace output directory | 0 | 0 | 256 | Error trace output directory specified in the TrcPath parameter |
Size of error trace file to be output | 100 | 256 | 4 | Size of the output error trace file, as specified in the size parameter | |
Flag indicating whether or not error trace is to be acquired | 104 | 260 | 4 | Flag indicating whether or not error trace is to be acquired, as specified in the flag parameter (if the flag parameter is set to true, 1 is output; if it is set to false, 0 is output) | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-36 Information for the setMethodTraceMode method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Method trace output directory | 0 | 0 | 256 | Method trace output directory specified in the TrcPath parameter |
Size of method trace file to be output | 100 | 256 | 4 | Size of the output method trace file, as specified in the size parameter | |
Flag indicating whether or not method trace is to be acquired | 104 | 260 | 4 | Flag indicating whether or not method trace is to be acquired, as specified in the flag parameter (if the flag parameter is set to true, 1 is output; if it is set to false, 0 is output) | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-37 Information for the setDataTraceMode method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | Data trace output directory | 0 | 0 | 256 | Data trace output directory specified in the TrcPath parameter |
Size of data trace file to be output | 100 | 256 | 4 | Size of the output data trace file, as specified in the size parameter | |
Size of data to be output to the data trace | 104 | 260 | 4 | Size of the data to be output to the data trace, as specified in the DataSize parameter | |
Flag indicating whether or not data trace is to be acquired | 108 | 264 | 4 | Flag indicating whether or not data trace is to be acquired, as specified in the flag parameter (if the flag parameter is set to true, 1 is output; if it is set to false, 0 is output) | |
Exit point | None | N/A | N/A | N/A | N/A |
N/A: Not applicable
Table 2-38 Information for the trnChainedCommit method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | None | N/A | N/A | N/A | N/A |
Exit point | Performance analysis trace identification information | 0 | 0 | 26 | Performance analysis trace identification information |
N/A: Not applicable
Table 2-39 Information for the trnUnchainedCommit method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | None | N/A | N/A | N/A | N/A |
Exit point | Performance analysis trace identification information | 0 | 0 | 26 | Performance analysis trace identification information |
N/A: Not applicable
Table 2-40 Information for the trnChainedRollback method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | None | N/A | N/A | N/A | N/A |
Exit point | Performance analysis trace identification information | 0 | 0 | 26 | Performance analysis trace identification information |
N/A: Not applicable
Table 2-41 Information for the trnUnchainedRollback method
Collection location | Item | Location | Length (bytes) | Description | |
---|---|---|---|---|---|
Hexadecimal | Decimal | ||||
Entry point | None | N/A | N/A | N/A | N/A |
Exit point | Performance analysis trace identification information | 0 | 0 | 26 | Performance analysis trace identification information |
N/A: Not applicable
All Rights Reserved. Copyright (C) 2006, 2009, Hitachi, Ltd.