arm_get_arrival_time(3)

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

NAME

6       arm_get_arrival_time - store current time
7

SYNOPSIS

9       #include <arm4.h>
10
11       arm_error_t
12       arm_get_arrival_time(
13           arm_arrival_time_t *opaque_time);
14

DESCRIPTION

16       arm_get_arrival_time() stores a 64-bit integer representing the current
17       time.
18
19       There are situations in which there is a significant delay between  the
20       time  when  processing of a transaction begins and when all the context
21       property values that are needed before arm_start_transaction()  can  be
22       executed  are  known.  In  order  to get a more accurate response time,
23       arm_get_arrival_time() can be used to capture an implementation-defined
24       representation  of the current time. This integer value is later stored
25       in the arrival time sub-buffer when  arm_start_transaction()  executes.
26       The  ARM  library  will use the "arrival time" as the start time rather
27       than the moment when the arm_start_transaction() executes.
28
29       opaque_time is a pointer  to  an  arm_int64_t  that  will  contain  the
30       arrival  time  value.  Note that the value is implementation-defined so
31       the application should not make any conclusions based on its contents.
32

RETURN VALUE

34       On success, the function returns ARM_SUCCESS. A  non-zero  value  indi‐
35       cates an error.
36

ERRORS

38       If  the  return code is negative, an error occurred. If the return code
39       is not negative, an error may or may not have occurred - the determina‐
40       tion  of  what  is an error and whether an error code is returned is at
41       the discretion of the ARM implementation. The application can test  the
42       return code if it wants to provide its own error logging.
43
44       The following errors are recognized by this implementation, but may not
45       be portable to other implementations:
46
47
48       ARM_FAILURE_NULL_ARGUMENT
49              The opaque_time must not be null.
50

CONFORMING TO

52       ARM Issue 4.0 C Language Bindings, Version 2
53

EXAMPLE

55       None.
56