arm_subbuffer_message_rcvd_event Struct Reference [ARM 4.1 Sub-buffers]

used to pass an received event to the ARM implementation. More...

#include <arm41.h>

Data Fields
arm_subbuffer_t	header
arm_boolean_t	end_of_flow
arm_int32_t	event_count
const arm_message_rcvd_event_t *	message_event_array

---

Detailed Description

used to pass an received event to the ARM implementation.

The Message Received Event sub-buffer is optionally used to indicate that one or more messages have been received that have an effect on the execution state of a transaction. Some cases of interest are the following.

• A message causes the transaction to initiate.
• A message causes the transaction to unblock.
• A message is received that terminates an asynchronous transaction or a step in an asynchronous transaction.
• A message has been received during the processing of a transaction that does not fall into one of the categories above.

The Message Received Event sub-buffer can be provided on the following function calls:

• arm_start_transaction()
• arm_update_transaction()
• arm_stop_transaction()
• arm_block_transaction()
• arm_unblock_transaction()

,

---

Field Documentation

arm_boolean_t arm_subbuffer_message_rcvd_event::end_of_flow

A boolean that if true indicates that the currently executing transaction represents the last processing step in a compound transaction that started in another process. The arm_stop_transaction() of the currently executing transaction can be considered the stop time for the entire compound transaction. After this flag has been set to True, the value for the transaction instance is True; the flag is ignored in any other Message Received Event sub-buffers associated with this transaction instance.

arm_int32_t arm_subbuffer_message_rcvd_event::event_count

Count of message received event structures. The maximum value is 32. The minimum value is 0, which might occur if the purpose of passing the sub-buffer is to set the End of Flow indicator, even though there are no new message events to report.

arm_subbuffer_t arm_subbuffer_message_rcvd_event::header

header.format must be set to ARM_SUBBUFFER_MESSAGE_RCVD_EVENT

const arm_message_rcvd_event_t* arm_subbuffer_message_rcvd_event::message_event_array

Array of received event structures.

---

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

• arm41.h