arm_update_transaction(3)

1arm_update_transaction(3)  ARM 4 Programmer's Manual arm_update_transaction(3)
2
3
4

NAME

6       arm_update_transaction - get transaction status
7

SYNOPSIS

9       #include <arm4.h>
10
11       arm_error_t
12       arm_update_transaction(
13           const arm_tran_start_handle_t tran_handle,
14           const arm_int32_t flags,
15           const arm_buffer4_t *buffer4);
16

DESCRIPTION

18       arm_update_transaction()  signals  that a transaction is still process‐
19       ing.
20
21       arm_update_transaction() is useful as a heartbeat. It is also  used  to
22       pass  additional  data  about  a transaction. It can be called from any
23       thread in the process that executed the arm_start_transaction().
24
25       buffer4 is a pointer to the user data buffer, if any. If the pointer is
26       null  (ARM_BUF4_NONE), there is no buffer. The sub-buffer that might be
27       used is arm_subbuffer_metric_values_t.
28
29       flags contains 32-bit flags. No values are currently defined. The field
30       should be zero (ARM_FLAG_NONE).
31
32       tran_handle   is  a  handle  returned  in  an  out  parameter  from  an
33       arm_start_transaction() call in the same process.
34
35

RETURN VALUE

37       On success, the function returns ARM_SUCCESS. A  non-zero  value  indi‐
38       cates an error.
39

ERRORS

41       If  the  return code is negative, an error occurred. If the return code
42       is not negative, an error may or may not have occurred - the determina‐
43       tion  of  what  is an error and whether an error code is returned is at
44       the discretion of the ARM implementation. The application can test  the
45       return code if it wants to provide its own error logging.
46
47       The following errors are recognized by this implementation, but may not
48       be portable to other implementations:
49
50
51       ARM_FAILURE_TRANSACTION_INACTIVE
52              The tran_handle refers to a transaction that  is  inactive.  For
53              example, an arm_stop_transaction call may have been made on that
54              transaction.
55
56       ARM_FAILURE_TRANSACTION_BLOCKED
57              The transaction has already been blocked by a previous  call  to
58              arm_block_transaction().
59
60       ARM_FAILURE_INTERNAL_ERROR
61              An internal error has occurred that prevented the operation from
62              completing. Check your system log for more details.
63

CONFORMING TO

65       ARM Issue 4.0 C Language Bindings, Version 2
66

EXAMPLE

68       None.
69