ARM 4.1 Defines [ARM 4.1]

#define	ARM_CORR_FLAGNUM_ASYNCH   3
	Asynchronous flow flag number.
#define	ARM_CORR_FLAGNUM_INDEPENDENT   4
	Independent Flow flag number.
#define	ARM_SET_CORRELATOR_FLAG(corr, flag_num, boolean_value)
	Macro for modifying correlator flags.
#define	ARM_MESSAGE_SENT_EVENT_MAX_COUNT   32
	max. number of sent events.
#define	ARM_MESSAGE_RCVD_EVENT_MAX_COUNT   32
	max. number of received events.
#define	ARM_DIAG_PROPERTY_MAX_CHARS   2048
	max. length of name+value of a diagnostic property
#define	ARM_DIAG_PROPERTIES_MAX_CHARS   4096
	max. total length of diagnostic properties
#define	ARM_EVENT_DESCRIPTION_MAX_CHARS   128
	max. length of the description fields of block cause and message events
#define	ARM_BLOCK_CAUSE_SYNCHRONOUS_EVENT   1
	A synchronous call, such as an RPC (Remote Procedure Call) has been made and the application is awaiting a response before proceeding.
#define	ARM_BLOCK_CAUSE_ASYNCHRONOUS_EVENT   2
	The application has invoked an asynchronous transaction and/or is involved in a conversation that consists of exchanging messages.
#define	ARM41_APP_CONTROL_COUNT   12
	number of control fields starting with app_control_used
#define	ARM41_TRAN_ID_CONTROL_COUNT   9
	number of control fields starting with control_used
#define	ARM41_TRAN_INSTANCE_CONTROL_COUNT   10
	number of control fields starting with control_used
#define	ARM_COLLECTION_DEPTH_NONE   0
	The implementation prefers that the application does not instrument any transactions.
#define	ARM_COLLECTION_DEPTH_PROCESS   1
	The implementation prefers that the application instrument these transactions at a process granularity; i.e., that it use a single arm_start_transaction()/arm_stop_transaction() pair per process.
#define	ARM_COLLECTION_DEPTH_CONTAINER   2
	The implementation prefers that the application instruments these transactions at a container granularity; i.e., that it use a single start/stop pair per container.
#define	ARM_COLLECTION_DEPTH_MAX   3
	The implementation prefers that the application instruments transactions at the maximum possible granularity. This may be the same as the process or container granularity, depending on the application.

---

Define Documentation

#define ARM41_APP_CONTROL_COUNT   12

number of control fields starting with app_control_used

See also:

arm_subbuffer_app_control_t.

#define ARM41_TRAN_ID_CONTROL_COUNT   9

number of control fields starting with control_used

See also:

arm_subbuffer_tran_id_control_t.

#define ARM41_TRAN_INSTANCE_CONTROL_COUNT   10

number of control fields starting with control_used

See also:

arm_subbuffer_tran_id_control_t.

#define ARM_BLOCK_CAUSE_ASYNCHRONOUS_EVENT   2

The application has invoked an asynchronous transaction and/or is involved in a conversation that consists of exchanging messages.

It is currently waiting for another message or prior message response or some asynchronous event before proceeding with the execution of the current transaction.

#define ARM_COLLECTION_DEPTH_CONTAINER   2

The implementation prefers that the application instruments these transactions at a container granularity; i.e., that it use a single start/stop pair per container.

The determination of what constitutes a container is at the discretion of the application architect who designs the ARM instrumentation. For many applications the only logical container boundary is also the process boundary, in which case there would be no difference in how the settings of ARM_COLLECTION_DEPTH_PROCESS and ARM_COLLECTION_DEPTH_CONTAINER would be interpreted. For other applications, such as complex middleware that may contain a web server, J2EE container, JDBC connectors, there could be multiple containers running within the same process.

#define ARM_CORR_FLAGNUM_ASYNCH   3

Asynchronous flow flag number.

See also:

arm_get_correlator_flags(), ARM_SET_CORRELATOR_FLAG()

#define ARM_CORR_FLAGNUM_INDEPENDENT   4

Independent Flow flag number.

See also:

arm_get_correlator_flags(), ARM_SET_CORRELATOR_FLAG()

#define ARM_SET_CORRELATOR_FLAG	(		corr,
			flag_num,
			boolean_value
	)

Value:

(corr)->opaque[3] = (boolean_value)                                     \
      ? ((corr)->opaque[3] |  ((arm_uint8_t)0x80 >> (arm_uint8_t)((flag_num)-1))) \
      : ((corr)->opaque[3] & ~((arm_uint8_t)0x80 >> (arm_uint8_t)((flag_num)-1)))

Macro for modifying correlator flags.

The macro sets the Boolean value of one of the flags in the correlator pointed to by corr. If the application intends to set both the Asynchronous Flow and Independent Transaction flags, it would use the macro twice. Since this is a macro, compile-time type checking might not apply.

Parameters:

	corr	Pointer to a correlator. The type of the pointer must be (const arm_correlator_t *).
	flag_num	Enumerated value indicating the flag to be changed. The following values are allowed: ARM_CORR_FLAGNUM_ASYNCH ARM_CORR_FLAGNUM_INDEPENDENT
	boolean_value	The value to set the flag to. Must be ARM_TRUE or ARM_FALSE.