1 /* 2 * 3 * Copyright 2015 gRPC authors. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 */ 18 19 #ifndef GRPCPP_IMPL_CODEGEN_TIME_H 20 #define GRPCPP_IMPL_CODEGEN_TIME_H 21 22 // IWYU pragma: private, include <grpcpp/support/time.h> 23 24 #include <chrono> 25 26 #include <grpc/impl/codegen/grpc_types.h> 27 #include <grpcpp/impl/codegen/config.h> 28 29 namespace grpc { 30 31 /** If you are trying to use CompletionQueue::AsyncNext with a time class that 32 isn't either gpr_timespec or std::chrono::system_clock::time_point, you 33 will most likely be looking at this comment as your compiler will have 34 fired an error below. In order to fix this issue, you have two potential 35 solutions: 36 37 1. Use gpr_timespec or std::chrono::system_clock::time_point instead 38 2. Specialize the TimePoint class with whichever time class that you 39 want to use here. See below for two examples of how to do this. 40 */ 41 template <typename T> 42 class TimePoint { 43 public: 44 // If you see the error with methods below, you may need either 45 // i) using the existing types having a conversion class such as 46 // gpr_timespec and std::chrono::system_clock::time_point or 47 // ii) writing a new TimePoint<YourType> to address your case. 48 TimePoint(const T& /*time*/) = delete; 49 gpr_timespec raw_time() = delete; 50 }; 51 52 template <> 53 class TimePoint<gpr_timespec> { 54 public: 55 /* NOLINTNEXTLINE(google-explicit-constructor) */ TimePoint(const gpr_timespec & time)56 TimePoint(const gpr_timespec& time) : time_(time) {} raw_time()57 gpr_timespec raw_time() { return time_; } 58 59 private: 60 gpr_timespec time_; 61 }; 62 63 } // namespace grpc 64 65 namespace grpc { 66 67 // from and to should be absolute time. 68 void Timepoint2Timespec(const std::chrono::system_clock::time_point& from, 69 gpr_timespec* to); 70 void TimepointHR2Timespec( 71 const std::chrono::high_resolution_clock::time_point& from, 72 gpr_timespec* to); 73 74 std::chrono::system_clock::time_point Timespec2Timepoint(gpr_timespec t); 75 76 template <> 77 class TimePoint<std::chrono::system_clock::time_point> { 78 public: 79 /* NOLINTNEXTLINE(google-explicit-constructor) */ TimePoint(const std::chrono::system_clock::time_point & time)80 TimePoint(const std::chrono::system_clock::time_point& time) { 81 Timepoint2Timespec(time, &time_); 82 } raw_time()83 gpr_timespec raw_time() const { return time_; } 84 85 private: 86 gpr_timespec time_; 87 }; 88 89 } // namespace grpc 90 91 #endif // GRPCPP_IMPL_CODEGEN_TIME_H 92