arm_subbuffer_message_sent_event Struct Reference
[ARM 4.1 Sub-buffers]
used to pass a sent 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_sent_event_t * | message_event_array |
Detailed Description
used to pass a sent event to the ARM implementation.
The Message Sent Event sub-buffer is optionally used to indicate that one or more messages have been sent that have an effect on the execution state of a transaction. The cases of interest are the following.
- A message is sent that causes the transaction to block.
- A message is sent that initiates or terminates an asynchronous transaction or a step in an asynchronous transaction.
- A message is sent that is part of a conversational exchange between this transaction and another transaction.
- A message is sent that is not part of a known conversational exchange.
The Message Sent 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
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. It serves no purpose to set this flag more than once for a given transaction instance.
Count of message sent event structures. The maximum value is 32. The minimum value is 0, which might occur if the End of Flow indicator = true and there are no new message events to report.
header.format must be set to ARM_SUBBUFFER_MESSAGE_SENT_EVENT
Array of sent event structures.
The documentation for this struct was generated from the following file:
Documentation generated on Thu May 24 2018 22:24:14. © 2018 by MyARM GmbH