arm_start_transaction (3) - Linux Manuals
arm_start_transaction: start transaction
NAME
arm_start_transaction - start transactionSYNOPSIS
#include <arm4.h>
arm_error_t
arm_start_transaction(
DESCRIPTION
arm_start_transaction() is used to indicate that a transaction is beginning execution.
Call arm_start_transaction() just prior to a transaction beginning execution.
arm_start_transaction() signals the ARM library to start timing the transaction response time.
There is one exception: when arm_get_arrival_time() is used to get a start time before
arm_start_transaction() executes. See arm_get_arrival_time() to understand this usage.
app_handle is a handle returned in an out parameter from an arm_start_application() call in the
same process.
buffer4 is a pointer to the user data buffer, if any. If the pointer is null (ARM_BUF4_NONE),
there is no buffer. The sub-buffers that may be used are
arm_subbuffer_arrival_time_t, arm_subbuffer_metric_values_t,
arm_subbuffer_tran_context_t, and arm_subbuffer_user_t.
current_correlator is a pointer to a buffer into which the ARM implementation will store a correlator for
the transaction instance, if any. The length of the buffer should be (at least) 512
(ARM_CORR_MAX_LENGTH) bytes.
If the pointer is not null, the application is requesting that a correlator be created. In
this case the ARM implementation may (but need not) create a correlator in the
buffer. It may not create a correlator if it does not support the function or if it is
configured to not create a correlator.
flags contains 32-bit flags. These may be combined using a binary or (|) operation. Three flags are defined:
tran_handle is a pointer to an arm_int64_t into which the ARM library will store the value of the
handle that will represent the transaction instance in all calls, up to and including
the arm_stop_transaction() that indicates that the instance has completed executing.
The scope of the handle is the process in which the arm_start_transaction() is
executed.
The following errors are recognized by this implementation, but may not be portable to other implementations:
RETURN VALUE
On success, the function returns ARM_SUCCESS. A non-zero value indicates
an error.
ERRORS
If the return code is negative, an error occurred. If the return code is not negative, an error may
or may not have occurred - the determination of what is an error and whether an error code is
returned is at the discretion of the ARM implementation. The application can test the return code
if it wants to provide its own error logging.
CONFORMING TO
ARM Issue 4.0 C Language Bindings, Version 2
EXAMPLE
None.
SEE ALSO
arm_bind_thread(3),
arm_block_transaction(3),
arm_get_arrival_time(3),
arm_get_correlator_length(3),
arm_register_transaction(3),
arm_start_application(3),
arm_stop_transaction(3),
arm_unbind_thread(3),
arm_unblock_transaction(3),
arm_update_transaction(3)