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

used to specify additional identity properties for a transaction More...

#include <arm4.h>

Data Fields
arm_subbuffer_t	header
arm_int32_t	identity_property_count
const arm_property_t *	identity_property_array
arm_int32_t	context_name_count
const arm_char_t **	context_name_array
const arm_char_t *	uri

---

Detailed Description

used to specify additional identity properties for a transaction

Transactions are identified by a name, an optional URI value, and an optional set of attribute (name,value) pairs. The URI and optional (name,value) pairs are provided in this sub-buffer on the arm_register_transaction() call. The sub-buffer is ignored if it is passed on any other call. The identity is scoped to a single application.

The names of identity and context properties can be any string, with one exception. Strings beginning with the four characters "ARM:" are reserved for the ARM specification. The specification will define names with known + semantics using this prefix. One name format is currently defined. Any name beginning with the eight-character prefix "ARM:CIM:" represents a name defined using the DMTF CIM (Distributed Management Task Force Common Information Model) naming rules. For example, "ARM:CIM:CIM_SoftwareElement.Name" indicates that the property value has the semantics of the Name property of the CIM_SoftwareElement class. It is anticipated that additional naming semantics are likely to be added in the future.

---

Field Documentation

const arm_char_t** arm_subbuffer_tran_identity::context_name_array

An array of character pointers to the context property names.

If a name is repeated in the array, the name and its corresponding value (in the transaction context sub-buffer) are ignored, and the first instance of the name in the array (and its corresponding value) is used. The implementation may return an error code but is not obliged to do so.

Each pointer in the array is aligned as required for the C compiler on the platform. Each array element contains:

• name: A null-terminated string representing the name part of the (name,value) pair. Each string has a maximum length of 128 characters, including the termination character. If any pointer is null or points to a zero-length string, the (name,value) pair is ignored. The values are provided in the Transaction Context Values sub-buffer (arm_subbuffer_tran_context_t). Names should not contain trailing blank characters or consist of only blank characters.

arm_int32_t arm_subbuffer_tran_identity::context_name_count

count of context names in the following array.

arm_subbuffer_t arm_subbuffer_tran_identity::header

header.format must be set to ARM_SUBBUFFER_TRAN_IDENTITY

const arm_property_t* arm_subbuffer_tran_identity::identity_property_array

An array of C structures containing the property names and values.

The array index of a property value in the value array is bound to the property name at the same index in the name array. Moving the (name,value) pair to a different index does not affect the identity of the transaction. For example, if an application registers once with a name A and a value X in array indices 0 and once with the same name and value in array indices 1, the registered identity has not changed.

If a name is repeated in the array, the name and its corresponding value are ignored, and the first instance of the name and value in the array is used. The implementation may return an error code but is not obliged to do so.

Each structure is aligned as required for the C compiler on the platform.

arm_int32_t arm_subbuffer_tran_identity::identity_property_count

count of property values in the following array.#

const arm_char_t* arm_subbuffer_tran_identity::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. A zero-length string is treated as a null value.

---

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

• arm4.h