arm_subbuffer_metric_bindings Struct Reference [ARM 4.0 Metrics, ARM 4.0 Sub-buffers]

used to associate metrics to a transaction More...

#include <arm4.h>

Data Fields
arm_subbuffer_t	header
arm_int32_t	count
const arm_metric_binding_t *	metric_binding_array

---

Detailed Description

used to associate metrics to a transaction

Applications may provide additional data about a transaction when the transaction starts, while it is executing, and/or after it has stopped. This additional data may serve several purposes, such as indicating the size of a transaction (e.g., the number of bytes in a file for a file transfer transaction), the state of the system (e.g., the number of queued up transactions when this transaction arrived), or an error code. The metadata describing each metric is provided with the arm_register_metric() function.

Each transaction definition may define zero to seven metrics for which data values may be provided on arm_start_transaction(), arm_update_transaction(), arm_stop_transaction(), or arm_report_transaction(). Each metric is assigned to an array slot numbered 0 to 6 (they were numbered 1 to 7 in ARM 2.0). This sub-buffer is passed on the arm_register_transaction() function to indicate which metrics are assigned to which slots.

The combination of this sub-buffer plus the arm_register_metric() function replaces ARM 2.0 format = 101. Unlike ARM 2.0, the metric definitions do not influence the transaction identity. Any properties besides the transaction name that affect identity are provided in the Transaction Identity Properties (arm_subbuffer_tran_identity_t) sub-buffer.

---

Field Documentation

arm_int32_t arm_subbuffer_metric_bindings::count

count of metric values in the following array.

arm_subbuffer_t arm_subbuffer_metric_bindings::header

header.format must be set to ARM_SUBBUFFER_METRIC_BINDINGS

const arm_metric_binding_t* arm_subbuffer_metric_bindings::metric_binding_array

An array of C structures containing the metric bindings. Each structure is aligned as required for the C compiler on the platform.

---

The documentation for this struct was generated from the following file:

• arm4.h