OpenTP1 Version 7 Programming Reference C Language

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

dc_rts_utrace_put - Acquire real-time statistical information for arbitrary section

Format

K&R C

#include <dcrts.h>
int dc_rts_utrace_put (event_id, flags);
DCLONG   event_id;
DCLONG   flags;

Description

The function dc_rts_utrace_put() acquires, as real-time statistical information, the execution time and execution count of the event set in event_id for arbitrary section within the UAP.

Arguments whose values are set in the UAP

event_id

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

The range of available event IDs is 1000000 to 2147483647.

flags

Set the processing to be executed by the function dc_rts_utrace_put().

DCRTS_START
This flag starts measurement of the execution time of the event ID set in event_id.
Real-time statistical information is not acquired when the function dc_rts_utrace_put() is called with this flag set.

DCRTS_END
This flag acquires the execution time of the event ID set in event_id and terminates measurement.

DCNOFLAGS
This flag acquires only the execution frequency of the event ID set in event_id. The execution time is 0 seconds.

Return values

Return value Return value (numeric) Explanation
DC_OK 0 Normal termination.
DCRTSER_PARAM -7802 The value specified for an argument is incorrect.
DCRTSER_PROTO -7803 The function dc_rpc_open() was not called.
The function dc_rts_utrace_put() was called with an event ID for which measurement of the execution time has already started set in event_id and DCRTS_START set in flags.
The function dc_rts_utrace_put() was called with an event ID for which measurement of the execution time has not yet started set in event_id and DCRTS_END set in flags.
DCRTSER_ITEM_OVER -7804 The information cannot be acquired because the number of acquired items exceeds the value specified for the rts_item_max operand in the real-time statistical information service definition.
DCRTSER_ITEM_OVER_SRV -7805 The information cannot be acquired because the number of acquired items per server exceeds the value specified for the rts_item_max operand in the real-time statistical information service definition. This return value indicates that statistical information for each service or for non-service processes has been acquired.
DCRTSER_ITEM_OVER_SVC -7806 The information cannot be acquired because the number of acquired items per service or non-service process exceeds the value specified for the rts_item_max operand in the real-time statistical information service definition. This return value indicates that statistical information for each server has been acquired.
DCRTSER_NOMEM -7807 Processing cannot be executed because process memory is insufficient.
DCRTSER_RTS_NOT_START -7808 The real-time statistical information service has not started.
DCRTSER_NOENTRY -7809 The caller of the function dc_rts_utrace_put has not been registered as a recipient for the acquisition of real-time statistical information on a server or service basis.
DCRTSER_VERSION -7810 The UAP is linked with a library whose version is not supported by the currently operating real-time statistical information service.

Notes

  1. The function dc_rts_utrace_put() cannot acquire real-time statistical information for the entire system.
  2. On a UAP that uses a multi-server, if multiple processes simultaneously call the function dc_rts_utrace_put() with the same call source service and same event_id set, depending on the process, the function may not acquire statistical information. This is because lock is not performed during statistical information acquisition processing, and so write processes are performed simultaneously.
  3. On a UAP that uses the XATMI interface, real-time statistical information cannot be acquired for individual services. Information is acquired as statistical information for all non-service processes.
  4. The function dc_rts_utrace_put() cannot acquire a UAP trace.
  5. This note applies after the function dc_rts_utrace_put called by specifying DCRTS_START in the flags argument returns DCRTSER_RTS_NOT_START or DCRTSER_NOENTRY. If the real-time statistical information service is started to add the calling UAP as a target of acquisition processing before the function dc_rts_utrace_put is called by specifying DCRTS_END in flags with the same event ID, the function returns DCRTSER_PROTO.