arm_subbuffer_arrival_time Struct Reference [ARM 4.0 Sub-buffers]

used to pass the arrival time for a transaction instance. More...

#include <arm4.h>

Data Fields
arm_subbuffer_t	header
arm_arrival_time_t	opaque_time

---

Detailed Description

used to pass the arrival time for a transaction instance.

Some applications may start processing a transaction before all the context information that identifies the transaction is known. For example, it might by necessary to retrieve the context information as the first step in processing the transaction.

When the application can call ARM when the transaction starts but not call arm_start_transaction() because it does not yet have all the data it needs, the application can call arm_get_arrival_time() to receive a timestamp value for the current time from the ARM implementation. This timestamp value is known as the "arrival time". When the transaction context data is all known, arm_start_transaction() is called, passing the optional arrival time value in the Arrival Time sub-buffer, to indicate when the transaction actually started executing.

The arrival time field is a 64-bit integer containing the value returned by the arm_get_arrival_time() function. The format of the data is implementation-defined.

---

Field Documentation

arm_subbuffer_t arm_subbuffer_arrival_time::header

header.format must be set to ARM_SUBBUFFER_ARRIVAL_TIME

arm_arrival_time_t arm_subbuffer_arrival_time::opaque_time

An arm_int64_t value containing an opaque time indicator generated by and recognizable by the ARM implementation.

---

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

• arm4.h