OpenTP1 Version 7 Programming Reference COBOL Language

[Contents][Index][Back][Next]

CBLDCRTS('RTSPUT ') - Acquire real-time statistical information for arbitrary section

Format

PROCEDURE DIVISION specification

CALL  'CBLDCRTS'  USING  unique-name-1  unique-name-2

DATA DIVISION specification

01 unique-name-1.
   02 data-name-A  PIC X(8) VALUE 'RTSPUT  '.
   02 data-name-B  PIC X(5).
   02 FILLER      PIC X(3).
   02 data-name-Z  PIC S9(9) COMP VALUE ZERO.
 
01 unique-name-2.
   02 data-name-C  PIC S9(9) COMP.
   02 data-name-D  PIC X(1).
   02 FILLER      PIC X(3).

Description

CBLDCRTS('RTSPUT ') acquires the execution time and the number of executions for the item assigned to data-name-C while the UAP executions over an arbitrary section, as real-time statistical information.

Data areas whose values are set in the UAP

data-name-A

Specify VALUE 'RTSPUT[Figure]' for the request code of the command to be executed.

data-name-C

Specify the ID of the real-time statistical item to be acquired.

The specified ID must be within the range from 1000000 to 2147483647.

data-name-D

Specify the operation to be performed.

VALUE 'S'
Starts measuring the execution time for the item ID assigned to data-name-C.
Note that real-time statistical information acquisition does not start when CBLDCRTS('RTSPUT ') is called with VALUE'S' specified.

VALUE 'E'
Ends measurement after acquiring the execution time for the item ID assigned to data-name-C.

VALUE '[Figure]'
Specifies that only the number of executions for the item ID assigned to data-name-C be acquired. The returned execution time will be 0 (in seconds).

data-name-Z

Specify 0.

Data area whose value is returned from OpenTP1

data-name-B

A status code of 5 digits is returned.

Status codes

Status code Explanation
00000 Normal termination.
07801 The request code (data-name-A) is invalid.
07802 The value specified for the data name is invalid.
07803 CBLDCRPC('OPEN ') was not called
CBLDCRTS('RTSPUT ') was called with 'S' assigned to data-name-D, but execution time measurement has already started for the item identified by the ID assigned to data-name-C.
CBLDCRTS('RTSPUT ') was called with 'E' assigned to data-name-D, but execution time measurement has not started for the item identified by the ID assigned to data-name-C.
07804 Information cannot be acquired because the number of items to be acquired exceeds the value assigned to the rts_item_max operand in the real-time statistical information service definition.
07805 Information cannot be acquired because the number of items to be acquired for each server exceeds the value assigned to the rts_item_max operand in the real-time statistical information service definition. If CBLDCRTS('RTSPUT ') returns with this status code, it has already acquired statistical information on individual services or non-service processings.
07806 Information cannot be acquired because the number of items to be acquired for each service or non-service processings exceeds the value assigned to the rts_item_max operand in the real-time statistical information service definition. If CBLDCRTS('RTSPUT ') returns with this status code, it has already acquired statistical information on individual servers.
07807 Processing cannot be performed because the process memory is insufficient.
07808 The real-time statistical information service is not started.
07809 The caller of the function CBLDCRTS('RTSPUT ') has not been registered as a recipient for the acquisition of real-time statistical information on a server or service basis.
07810 The UAP is linked with a library whose version is not supported by the currently operating real-time statistical information service.

Notes

  1. CBLDCRTS('RTSPUT ') cannot acquire system-wide real-time statistical information.
  2. If a UAP that uses multi-server features concurrently calls multiple CBLDCRTS('RTSPUT ') instances for which the same caller service and the same data names are specified from multiple processes, it may not acquire statistical information for some processes. This is because multiple writes occur at the same time as no lock control is in effect on statistical information acquisition.
  3. For a UAP that uses the XATMI interface, service-specific real-time statistical information cannot be acquired. All statistical information will be acquired as statistical information for non-service processings.
  4. CBLDCRTS('RTSPUT ') does not acquire UAP trace data.
  5. This note applies after the function CBLDCRTS('RTSPUT '), called by specifying 'S' in data-name-D, returns status code 07808 or 07809. If the real-time statistical information service is started and the calling UAP is added as a target of acquisition processing before CBLDCRTS('RTSPUT ') is called by specifying 'E' in data-name-D and specify the same ID (data-name-C), the function returns status code 07803.