arm_update_transaction (3) - Linux Manuals

arm_update_transaction: get transaction status

NAME

arm_update_transaction - get transaction status

SYNOPSIS

#include <arm4.h>

arm_error_t
arm_update_transaction(

 const arm_tran_start_handle_t tran_handle, 

 const arm_int32_t flags,

 const arm_buffer4_t *buffer4);

DESCRIPTION

arm_update_transaction() signals that a transaction is still processing.

arm_update_transaction() is useful as a heartbeat. It is also used to pass additional data about a transaction. It can be called from any thread in the process that executed the arm_start_transaction().

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-buffer that might be used is arm_subbuffer_metric_values_t.

flags contains 32-bit flags. No values are currently defined. The field should be zero (ARM_FLAG_NONE).
  tran_handle is a handle returned in an out parameter from an arm_start_transaction() call in the same process.

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.

The following errors are recognized by this implementation, but may not be portable to other implementations:

ARM_FAILURE_TRANSACTION_INACTIVE

The tran_handle refers to a transaction that is inactive. For example, an arm_stop_transaction call may have been made on that transaction.

ARM_FAILURE_TRANSACTION_BLOCKED

The transaction has already been blocked by a previous call to arm_block_transaction().

ARM_FAILURE_INTERNAL_ERROR

An internal error has occurred that prevented the operation from completing. Check your system log for more details.

CONFORMING TO

ARM Issue 4.0 C Language Bindings, Version 2

EXAMPLE

None.