folly/futures/ThreadWheelTimekeeper.h

   1 /*
   2  * Copyright 2014-present Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <folly/futures/Future.h>
  20 #include <folly/futures/Timekeeper.h>
  21 #include <folly/io/async/EventBase.h>
  22 #include <folly/io/async/HHWheelTimer.h>
  23 #include <thread>
  24
  25 namespace folly {
  26
  27 /// The default Timekeeper implementation which uses a HHWheelTimer on an
  28 /// EventBase in a dedicated thread. Users needn't deal with this directly, it
  29 /// is used by default by Future methods that work with timeouts.
  30 class ThreadWheelTimekeeper : public Timekeeper {
  31  public:
  32   /// But it doesn't *have* to be a singleton.
  33   ThreadWheelTimekeeper();
  34   ~ThreadWheelTimekeeper() override;
  35
  36   /// Implement the Timekeeper interface
  37   /// This future *does* complete on the timer thread. You should almost
  38   /// certainly follow it with a via() call or the accuracy of other timers
  39   /// will suffer.
  40   Future<Unit> after(Duration) override;
  41
  42  protected:
  43   folly::EventBase eventBase_;
  44   std::thread thread_;
  45   HHWheelTimer::UniquePtr wheelTimer_;
  46 };
  47
  48 } // namespace folly