arm_blocked() — Indicate the processing of a transaction is blocked
Standards
Standards / Extensions | C or C++ | Dependencies |
---|---|---|
both |
Format
#include <sys/_Elmarm4.h>
arm_error_t arm_blocked(
/* [in] */ arm_start_handle_t start_handle,
/* [in] */ arm_int32_t flags,
/* [in] */ arm_buffer4_t *buffer4,
/* [out] */ arm_block_handle_t *block_handle
);
General description
Use arm_blocked() to
indicate that processing of a transaction is blocked waiting for a
transaction in another application to complete. This helps to identify
what portion of a transaction's response time is spent in its own
application and what portion is spent in downstream applications.
- start_handle
- The handle returned by arm_start_transaction() for the transaction.
- flags
- Reserved for future use. The argument must be set to 0.
- buffer4
- A pointer to a buffer that identifies one or more sub-buffers containing additional data. Currently no sub-buffers are defined for this function so a null pointer should be passed. If a buffer is passed eWLM ignores it.
- block_handle
- A pointer to a 64-bit area where a handle that identifies the arm_blocked() call is returned. The handle must be passed to arm_unblocked(). The handle is valid only within the caller's process.
Returned value
On success, arm_blocked
returns ARM_RC_SUCCESS. On failure, the errno and return code are
set to indicate the error. See Return code for
the list of all possible return codes. On failure, the block_handle
is set to a dummy value which can be used for later calls to other
interfaces. Those interfaces will recognize that the block_handle
contains a dummy value and return without performing any action.
- Error Code
- Description
- EFAULT
- A parameter of this service contained an address that was not accessible to the caller.
- EINVAL
- A parameter of this service contained a value that was not valid.
- EMVSARMERROR
- An ARM error occurred. Refer to the return code for the specific error.
- EPERM
- The caller does not have the appropriate privileges. The return code is set to ARM_RC_AUTH_ERROR.
- EMVSSAF2ERR
- An error occurred in the security product.
Related information
- arm_bind_thread() — Bind the current thread to a given transaction
- arm_correlator_get_length() — Get the actual size of the transaction correlator
- arm_end_application() — Undefines an ARM application
- arm_get_correlator_max_length() — Get the max length of the transaction correlator
- arm_get_timestamp() — Get the current timestamp
- arm_init_application() — Defines an ARM application
- arm_init_transaction_type() — Defines and initializes an ARM transaction type
- arm_start_transaction() — Mark the start of an ARM transaction
- arm_stop_transaction() — Mark the end of an ARM transaction
- arm_unbind_thread() — Unbind the current thread to a given transaction
- arm_unblocked() — Indicate the processing of a transaction is no longer blocked
- arm_update_transaction() — Update a given transaction