Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright 2014, Google Inc. |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | #ifndef __GRPC_SUPPORT_TIME_H__ |
| 35 | #define __GRPC_SUPPORT_TIME_H__ |
| 36 | /* Time support. |
David Klempner | 9b60fa3 | 2015-02-04 09:48:53 -0800 | [diff] [blame] | 37 | We use gpr_timespec, which is analogous to struct timespec. On some |
| 38 | machines, absolute times may be in local time. */ |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 39 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 40 | #include <grpc/support/port_platform.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 41 | #include <stddef.h> |
David Klempner | 0c61dc5 | 2015-02-04 13:24:04 -0800 | [diff] [blame^] | 42 | #include <time.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 43 | |
| 44 | #ifdef __cplusplus |
| 45 | extern "C" { |
| 46 | #endif |
| 47 | |
David Klempner | 0c61dc5 | 2015-02-04 13:24:04 -0800 | [diff] [blame^] | 48 | typedef struct gpr_timespec { |
| 49 | time_t tv_sec; |
| 50 | int tv_nsec; |
| 51 | } gpr_timespec; |
| 52 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 53 | /* Time constants. */ |
| 54 | extern const gpr_timespec gpr_time_0; /* The zero time interval. */ |
| 55 | extern const gpr_timespec gpr_inf_future; /* The far future */ |
| 56 | extern const gpr_timespec gpr_inf_past; /* The far past. */ |
| 57 | |
| 58 | #define GPR_MS_PER_SEC 1000 |
| 59 | #define GPR_US_PER_SEC 1000000 |
| 60 | #define GPR_NS_PER_SEC 1000000000 |
| 61 | #define GPR_NS_PER_MS 1000000 |
| 62 | #define GPR_NS_PER_US 1000 |
| 63 | #define GPR_US_PER_MS 1000 |
| 64 | |
| 65 | /* Return the current time measured from the system's default epoch. */ |
| 66 | gpr_timespec gpr_now(void); |
| 67 | |
| 68 | /* Return -ve, 0, or +ve according to whether a < b, a == b, or a > b |
| 69 | respectively. */ |
| 70 | int gpr_time_cmp(gpr_timespec a, gpr_timespec b); |
| 71 | |
ctiller | 3bf466f | 2014-12-19 16:21:57 -0800 | [diff] [blame] | 72 | gpr_timespec gpr_time_max(gpr_timespec a, gpr_timespec b); |
| 73 | gpr_timespec gpr_time_min(gpr_timespec a, gpr_timespec b); |
| 74 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 75 | /* Add and subtract times. Calculations saturate at infinities. */ |
| 76 | gpr_timespec gpr_time_add(gpr_timespec a, gpr_timespec b); |
| 77 | gpr_timespec gpr_time_sub(gpr_timespec a, gpr_timespec b); |
| 78 | |
| 79 | /* Return a timespec representing a given number of microseconds. LONG_MIN is |
| 80 | interpreted as gpr_inf_past, and LONG_MAX as gpr_inf_future. */ |
| 81 | gpr_timespec gpr_time_from_micros(long x); |
| 82 | gpr_timespec gpr_time_from_nanos(long x); |
| 83 | gpr_timespec gpr_time_from_millis(long x); |
| 84 | gpr_timespec gpr_time_from_seconds(long x); |
| 85 | gpr_timespec gpr_time_from_minutes(long x); |
| 86 | gpr_timespec gpr_time_from_hours(long x); |
| 87 | |
ctiller | 58393c2 | 2015-01-07 14:03:30 -0800 | [diff] [blame] | 88 | gpr_int32 gpr_time_to_millis(gpr_timespec timespec); |
| 89 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 90 | /* Return 1 if two times are equal or within threshold of each other, |
| 91 | 0 otherwise */ |
| 92 | int gpr_time_similar(gpr_timespec a, gpr_timespec b, gpr_timespec threshold); |
| 93 | |
| 94 | /* Sleep until at least 'until' - an absolute timeout */ |
| 95 | void gpr_sleep_until(gpr_timespec until); |
| 96 | |
hongyu | 24200d3 | 2015-01-08 15:13:49 -0800 | [diff] [blame] | 97 | double gpr_timespec_to_micros(gpr_timespec t); |
| 98 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 99 | #ifdef __cplusplus |
| 100 | } |
| 101 | #endif |
| 102 | |
Craig Tiller | b5dcec5 | 2015-01-13 11:13:42 -0800 | [diff] [blame] | 103 | #endif /* __GRPC_SUPPORT_TIME_H__ */ |