arm_subbuffer_system_address Struct Reference [ARM 4.0 Sub-buffers]

used to specify a different system than the one on which the call is executed. More...

#include <arm4.h>

Data Fields
arm_subbuffer_t	header
arm_int16_t	address_format
arm_int16_t	address_length
const arm_uint8_t *	address
arm_boolean_t	id_valid
arm_id_t	id

---

Detailed Description

used to specify a different system than the one on which the call is executed.

The System Address sub-buffer is used with arm_start_application() when the transactions that will be reported execute on a different system than the one on which they will be reported.

• If no System Address sub-buffer is provided on arm_start_application(), all transactions reported by this application instance execute in the current process.
• If a System Address sub-buffer is provided on arm_start_application(), all transactions execute in a different process.
• If a System Address sub-buffer is provided in which the system address length is zero, or the system address pointer is null, the system is the "local" system, as determined by the ARM implementation.
• If a System Address sub-buffer is provided in which there is a non-null system address and length, the system may be the local system or a remote system. Interpretation of what is local versus remote is at the discretion of the ARM implementation.

---

Field Documentation

const arm_uint8_t* arm_subbuffer_system_address::address

A pointer to a byte array containing the system address.

• The byte array is the length specified by the "Length of system address" field. Note that it could have a length of zero bytes, or be a null pointer, indicating that it is the local system.

arm_int16_t arm_subbuffer_system_address::address_format

An arm_int16_t format of the system address field. The following formats are defined:

• ARM_SYSADDR_FORMAT_IPV4
• ARM_SYSADDR_FORMAT_IPV4PORT
• ARM_SYSADDR_FORMAT_IPV6
• ARM_SYSADDR_FORMAT_IPV6PORT
• ARM_SYSADDR_FORMAT_SNA
• ARM_SYSADDR_FORMAT_X25
• ARM_SYSADDR_FORMAT_HOSTNAME
• ARM_SYSADDR_FORMAT_UUID

arm_int16_t arm_subbuffer_system_address::address_length

An arm_int16_t length of system address in bytes.

• There is no maximum length.
• A length of zero refers to the local system.

arm_subbuffer_t arm_subbuffer_system_address::header

header.format must be set to ARM_SUBBUFFER_SYSTEM_ADDRESS

arm_id_t arm_subbuffer_system_address::id

A 16-byte character array containing an ID that can be used as a synonym for the tuple of (format, length, system address). If the "System Address" format is a UUID, and a "System Address ID" is provided, it is a coincidence if the values are identical. Nothing precludes or requires that they be the same.

• The ID is an optional identifier that is mapped to the other fields. If the value is all zeros, the ID is not being provided.

arm_boolean_t arm_subbuffer_system_address::id_valid

A boolean indicating whether the system address ID field contains a valid ID.

---

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

• arm4.h