arm_get_arrival_time (3) - Linux Man Pages

arm_get_arrival_time: store current time

NAME

arm_get_arrival_time - store current time

SYNOPSIS

#include <arm4.h>

arm_error_t
arm_get_arrival_time(

 arm_arrival_time_t *
opaque_time);

DESCRIPTION

arm_get_arrival_time() stores a 64-bit integer representing the current time.

There are situations in which there is a significant delay between the time when processing of a transaction begins and when all the context property values that are needed before arm_start_transaction() can be executed are known. In order to get a more accurate response time, arm_get_arrival_time() can be used to capture an implementation-defined representation of the current time. This integer value is later stored in the arrival time sub-buffer when arm_start_transaction() executes. The ARM library will use the "arrival time" as the start time rather than the moment when the arm_start_transaction() executes.

opaque_time is a pointer to an arm_int64_t that will contain the arrival time value. Note that the value is implementation-defined so the application should not make any conclusions based on its contents.

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_NULL_ARGUMENT
The opaque_time must not be null.

CONFORMING TO

ARM Issue 4.0 C Language Bindings, Version 2

EXAMPLE

None.

SEE ALSO

arm_start_transaction(3)