Line data    Source code

       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             : #include <chrono>
      23             : 
      24             : #include <grpc/impl/codegen/grpc_types.h>
      25             : #include <grpcpp/impl/codegen/config.h>
      26             : 
      27             : namespace grpc {
      28             : 
      29             : /** If you are trying to use CompletionQueue::AsyncNext with a time class that
      30             :     isn't either gpr_timespec or std::chrono::system_clock::time_point, you
      31             :     will most likely be looking at this comment as your compiler will have
      32             :     fired an error below. In order to fix this issue, you have two potential
      33             :     solutions:
      34             : 
      35             :       1. Use gpr_timespec or std::chrono::system_clock::time_point instead
      36             :       2. Specialize the TimePoint class with whichever time class that you
      37             :          want to use here. See below for two examples of how to do this.
      38             :  */
      39             : template <typename T>
      40             : class TimePoint {
      41             :  public:
      42             :   TimePoint(const T& time) { you_need_a_specialization_of_TimePoint(); }
      43             :   gpr_timespec raw_time() {
      44             :     gpr_timespec t;
      45             :     return t;
      46             :   }
      47             : 
      48             :  private:
      49             :   void you_need_a_specialization_of_TimePoint();
      50             : };
      51             : 
      52             : template <>
      53             : class TimePoint<gpr_timespec> {
      54             :  public:
      55             :   TimePoint(const gpr_timespec& time) : time_(time) {}
      56             :   gpr_timespec raw_time() { return time_; }
      57             : 
      58             :  private:
      59             :   gpr_timespec time_;
      60             : };
      61             : 
      62             : }  // namespace grpc
      63             : 
      64             : namespace grpc {
      65             : 
      66             : // from and to should be absolute time.
      67             : void Timepoint2Timespec(const std::chrono::system_clock::time_point& from,
      68             :                         gpr_timespec* to);
      69             : void TimepointHR2Timespec(
      70             :     const std::chrono::high_resolution_clock::time_point& from,
      71             :     gpr_timespec* to);
      72             : 
      73             : std::chrono::system_clock::time_point Timespec2Timepoint(gpr_timespec t);
      74             : 
      75             : template <>
      76             : class TimePoint<std::chrono::system_clock::time_point> {
      77             :  public:
      78           0 :   TimePoint(const std::chrono::system_clock::time_point& time) {
      79           0 :     Timepoint2Timespec(time, &time_);
      80           0 :   }
      81           0 :   gpr_timespec raw_time() const { return time_; }
      82             : 
      83             :  private:
      84             :   gpr_timespec time_;
      85             : };
      86             : 
      87             : }  // namespace grpc
      88             : 
      89             : #endif  // GRPCPP_IMPL_CODEGEN_TIME_H