| 1 | .\" Copyright (c) 2005-2008 David Carter <dcarter@arm4.org> and others. |
|---|
| 2 | .\" All rights reserved. This program and the accompanying materials |
|---|
| 3 | .\" are made available under the terms of the Eclipse Public License v1.0 |
|---|
| 4 | .\" which accompanies this distribution, and is available at |
|---|
| 5 | .\" http://www.eclipse.org/legal/epl-v10.html |
|---|
| 6 | .TH "arm_get_arrival_time" 3 "August 2008" "arm4.org" "ARM 4 Programmer's Manual" |
|---|
| 7 | .SH NAME |
|---|
| 8 | arm_get_arrival_time \- store current time |
|---|
| 9 | .SH SYNOPSIS |
|---|
| 10 | .B #include <arm4.h> |
|---|
| 11 | .sp |
|---|
| 12 | \fBarm_error_t |
|---|
| 13 | .br |
|---|
| 14 | arm_get_arrival_time( |
|---|
| 15 | .br |
|---|
| 16 | arm_arrival_time_t *\fIopaque_time\fB);\fR |
|---|
| 17 | .SH DESCRIPTION |
|---|
| 18 | \fBarm_get_arrival_time()\fR stores a 64-bit integer representing the current time. |
|---|
| 19 | |
|---|
| 20 | There are situations in which there is a significant delay between the time when processing of a |
|---|
| 21 | transaction begins and when all the context property values that are needed before |
|---|
| 22 | \fBarm_start_transaction()\fR can be executed are known. In order to get a more accurate response |
|---|
| 23 | time, \fBarm_get_arrival_time()\fR can be used to capture an implementation\-defined representation |
|---|
| 24 | of the current time. This integer value is later stored in the arrival time sub\-buffer when |
|---|
| 25 | \fBarm_start_transaction()\fR executes. The ARM library will use the "arrival time" as the start time |
|---|
| 26 | rather than the moment when the \fBarm_start_transaction()\fR executes. |
|---|
| 27 | |
|---|
| 28 | \fIopaque_time\fR is a pointer to an \fBarm_int64_t\fR that will contain the arrival time value. Note that the |
|---|
| 29 | value is implementation-defined so the application should not make any |
|---|
| 30 | conclusions based on its contents. |
|---|
| 31 | .SH "RETURN VALUE" |
|---|
| 32 | On success, the function returns \fBARM_SUCCESS\fR. A non-zero value indicates |
|---|
| 33 | an error. |
|---|
| 34 | .SH ERRORS |
|---|
| 35 | If the return code is negative, an error occurred. If the return code is not negative, an error may |
|---|
| 36 | or may not have occurred - the determination of what is an error and whether an error code is |
|---|
| 37 | returned is at the discretion of the ARM implementation. The application can test the return code |
|---|
| 38 | if it wants to provide its own error logging. |
|---|
| 39 | |
|---|
| 40 | The following errors are recognized by this implementation, but may not be portable to other implementations: |
|---|
| 41 | |
|---|
| 42 | .TP |
|---|
| 43 | .B ARM_FAILURE_NULL_ARGUMENT |
|---|
| 44 | The \fIopaque_time\fR must not be null. |
|---|
| 45 | .SH "CONFORMING TO" |
|---|
| 46 | ARM Issue 4.0 C Language Bindings, Version 2 |
|---|
| 47 | .SH EXAMPLE |
|---|
| 48 | None. |
|---|
| 49 | .SH "SEE ALSO" |
|---|
| 50 | .BR arm_start_transaction (3) |
|---|
