arm_subbuffer_tran_context Struct Reference [ARM 4.0 Properties, ARM 4.0 Sub-buffers]

used to associate context properties to a transaction instance. More...

#include <arm4.h>

Data Fields
arm_subbuffer_t	header
arm_int32_t	context_value_count
const arm_char_t **	context_value_array
const arm_char_t *	uri

---

Detailed Description

used to associate context properties to a transaction instance.

In addition to the identity properties, a transaction may be described with additional context properties. Context properties differ from identity properties in that although the name is provided when the transaction is registered [arm_register_transaction()], the values are provided when a transaction is measured [arm_start_transaction() or arm_report_transaction()]. The value of an identity property never changes, whereas the value of a context property may change every time a transaction executes.

Context properties are of two forms. There may be one URI value and up to twenty (name,value) pairs. No name may duplicate the name of a transaction identity property.

---

Field Documentation

const arm_char_t** arm_subbuffer_tran_context::context_value_array

An array of pointers to character strings containing the property values. The values in the array are position-sensitive; each must align with the corresponding context property name in the Transaction Identity (arm_subbuffer_tran_identity_t) sub-buffer. If the corresponding property name pointer is null or points to a zero-length string, the value is ignored. Each pointer is aligned as required for the C compiler on the platform. Each array element contains:

• Value: A null-terminated string representing the value part of the (name,value) pair. Each string has a maximum length of 256 characters, including the termination character. If any pointer is null or points to a zero-length string, the meaning is that there is no value for this instance. The value should not contain trailing blank characters or consist of only blank characters.

arm_int32_t arm_subbuffer_tran_context::context_value_count

count of context values in the following array.

arm_subbuffer_t arm_subbuffer_tran_context::header

header.format must be set to ARM_SUBBUFFER_TRAN_CONTEXT

const arm_char_t* arm_subbuffer_tran_context::uri

Pointer to a string containing a URI, with a maximum of 4096 characters, including the termination character. The string is null terminated. The pointer may be null.

If a URI is provided in both the Transaction Identity sub-buffer and in the Transaction Context sub-buffer, the URI in the Transaction Identity sub-buffer must be the same as the URI provided in the Transaction Context sub-buffer, or a truncated subset.

---

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

• arm4.h