move ThreadWheelTimekeeper out of detail
authorJames Sedgwick <jsedgwick@fb.com>
Fri, 18 Sep 2015 22:24:53 +0000 (15:24 -0700)
committerfacebook-github-bot-4 <folly-bot@fb.com>
Fri, 18 Sep 2015 23:20:18 +0000 (16:20 -0700)
Summary: This can be useful on its own, will use in twagent

Reviewed By: @fugalh

Differential Revision: D2457778

folly/Makefile.am
folly/futures/Future.cpp
folly/futures/ThreadWheelTimekeeper.cpp [new file with mode: 0644]
folly/futures/ThreadWheelTimekeeper.h [new file with mode: 0644]
folly/futures/detail/ThreadWheelTimekeeper.cpp [deleted file]
folly/futures/detail/ThreadWheelTimekeeper.h [deleted file]

index 49c22ef6e2481d3e2dc2cc3e016ddd3620c572f3..2d90added67b27af92da191ed8b16947f4d7a8b2 100644 (file)
@@ -148,13 +148,13 @@ nobase_follyinclude_HEADERS = \
        futures/ScheduledExecutor.h \
        futures/SharedPromise.h \
        futures/SharedPromise-inl.h \
+       futures/ThreadWheelTimekeeper.h \
        futures/Timekeeper.h \
        futures/Try-inl.h \
        futures/Try.h \
        futures/Unit.h \
        futures/detail/Core.h \
        futures/detail/FSM.h \
-       futures/detail/ThreadWheelTimekeeper.h \
        futures/detail/Types.h \
        gen/Base.h \
        gen/Base-inl.h \
@@ -317,13 +317,13 @@ libfolly_la_SOURCES = \
        File.cpp \
        FileUtil.cpp \
        FingerprintTables.cpp \
-       futures/detail/ThreadWheelTimekeeper.cpp \
        futures/Barrier.cpp \
        futures/ThreadedExecutor.cpp \
        futures/Future.cpp \
        futures/InlineExecutor.cpp \
        futures/ManualExecutor.cpp \
        futures/QueuedImmediateExecutor.cpp \
+       futures/ThreadWheelTimekeeper.cpp \
        detail/Futex.cpp \
        GroupVarint.cpp \
        GroupVarintTables.cpp \
index 501322a154a2d6d69b6d1945ee41a48842c5ca87..bbab4003741f11757cb4ccc73d6bf17296a80ad4 100644 (file)
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 #include <folly/futures/Future.h>
-#include <folly/futures/detail/ThreadWheelTimekeeper.h>
+#include <folly/futures/ThreadWheelTimekeeper.h>
 #include <folly/Likely.h>
 
 namespace folly {
diff --git a/folly/futures/ThreadWheelTimekeeper.cpp b/folly/futures/ThreadWheelTimekeeper.cpp
new file mode 100644 (file)
index 0000000..e65f3db
--- /dev/null
@@ -0,0 +1,101 @@
+/*
+ * Copyright 2015 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include "ThreadWheelTimekeeper.h"
+
+#include <folly/Singleton.h>
+#include <folly/futures/Future.h>
+#include <future>
+
+namespace folly {
+
+namespace {
+  Singleton<ThreadWheelTimekeeper> timekeeperSingleton_;
+
+  // Our Callback object for HHWheelTimer
+  struct WTCallback : public folly::HHWheelTimer::Callback {
+    // Only allow creation by this factory, to ensure heap allocation.
+    static WTCallback* create(EventBase* base) {
+      // optimization opportunity: memory pool
+      return new WTCallback(base);
+    }
+
+    Future<Unit> getFuture() {
+      return promise_.getFuture();
+    }
+
+   protected:
+    EventBase* base_;
+    Promise<Unit> promise_;
+
+    explicit WTCallback(EventBase* base)
+        : base_(base) {
+      promise_.setInterruptHandler(
+        std::bind(&WTCallback::interruptHandler, this));
+    }
+
+    void timeoutExpired() noexcept override {
+      promise_.setValue();
+      delete this;
+    }
+
+    void interruptHandler() {
+      base_->runInEventBaseThread([=] {
+        cancelTimeout();
+        delete this;
+      });
+    }
+  };
+
+} // namespace
+
+
+ThreadWheelTimekeeper::ThreadWheelTimekeeper() :
+  thread_([this]{ eventBase_.loopForever(); }),
+  wheelTimer_(new HHWheelTimer(&eventBase_, std::chrono::milliseconds(1)))
+{
+  eventBase_.waitUntilRunning();
+  eventBase_.runInEventBaseThread([this]{
+    // 15 characters max
+    eventBase_.setName("FutureTimekeepr");
+  });
+}
+
+ThreadWheelTimekeeper::~ThreadWheelTimekeeper() {
+  eventBase_.runInEventBaseThreadAndWait([this]{
+    wheelTimer_->cancelAll();
+    eventBase_.terminateLoopSoon();
+  });
+  thread_.join();
+}
+
+Future<Unit> ThreadWheelTimekeeper::after(Duration dur) {
+  auto cob = WTCallback::create(&eventBase_);
+  auto f = cob->getFuture();
+  eventBase_.runInEventBaseThread([=]{
+    wheelTimer_->scheduleTimeout(cob, dur);
+  });
+  return f;
+}
+
+namespace detail {
+
+Timekeeper* getTimekeeperSingleton() {
+  return timekeeperSingleton_.get();
+}
+
+} // detail
+
+} // folly
diff --git a/folly/futures/ThreadWheelTimekeeper.h b/folly/futures/ThreadWheelTimekeeper.h
new file mode 100644 (file)
index 0000000..63cb23a
--- /dev/null
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2015 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <folly/futures/Future.h>
+#include <folly/futures/Timekeeper.h>
+#include <folly/io/async/EventBase.h>
+#include <folly/io/async/HHWheelTimer.h>
+#include <thread>
+
+namespace folly {
+
+/// The default Timekeeper implementation which uses a HHWheelTimer on an
+/// EventBase in a dedicated thread. Users needn't deal with this directly, it
+/// is used by default by Future methods that work with timeouts.
+class ThreadWheelTimekeeper : public Timekeeper {
+ public:
+  /// But it doesn't *have* to be a singleton.
+  ThreadWheelTimekeeper();
+  ~ThreadWheelTimekeeper() override;
+
+  /// Implement the Timekeeper interface
+  /// This future *does* complete on the timer thread. You should almost
+  /// certainly follow it with a via() call or the accuracy of other timers
+  /// will suffer.
+  Future<Unit> after(Duration) override;
+
+ protected:
+  folly::EventBase eventBase_;
+  std::thread thread_;
+  HHWheelTimer::UniquePtr wheelTimer_;
+};
+
+} // folly
diff --git a/folly/futures/detail/ThreadWheelTimekeeper.cpp b/folly/futures/detail/ThreadWheelTimekeeper.cpp
deleted file mode 100644 (file)
index cd10671..0000000
+++ /dev/null
@@ -1,97 +0,0 @@
-/*
- * Copyright 2015 Facebook, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-#include "ThreadWheelTimekeeper.h"
-
-#include <folly/Singleton.h>
-#include <folly/futures/Future.h>
-#include <future>
-
-namespace folly { namespace detail {
-
-namespace {
-  Singleton<ThreadWheelTimekeeper> timekeeperSingleton_;
-
-  // Our Callback object for HHWheelTimer
-  struct WTCallback : public folly::HHWheelTimer::Callback {
-    // Only allow creation by this factory, to ensure heap allocation.
-    static WTCallback* create(EventBase* base) {
-      // optimization opportunity: memory pool
-      return new WTCallback(base);
-    }
-
-    Future<Unit> getFuture() {
-      return promise_.getFuture();
-    }
-
-   protected:
-    EventBase* base_;
-    Promise<Unit> promise_;
-
-    explicit WTCallback(EventBase* base)
-        : base_(base) {
-      promise_.setInterruptHandler(
-        std::bind(&WTCallback::interruptHandler, this));
-    }
-
-    void timeoutExpired() noexcept override {
-      promise_.setValue();
-      delete this;
-    }
-
-    void interruptHandler() {
-      base_->runInEventBaseThread([=] {
-        cancelTimeout();
-        delete this;
-      });
-    }
-  };
-
-} // namespace
-
-
-ThreadWheelTimekeeper::ThreadWheelTimekeeper() :
-  thread_([this]{ eventBase_.loopForever(); }),
-  wheelTimer_(new HHWheelTimer(&eventBase_, std::chrono::milliseconds(1)))
-{
-  eventBase_.waitUntilRunning();
-  eventBase_.runInEventBaseThread([this]{
-    // 15 characters max
-    eventBase_.setName("FutureTimekeepr");
-  });
-}
-
-ThreadWheelTimekeeper::~ThreadWheelTimekeeper() {
-  eventBase_.runInEventBaseThreadAndWait([this]{
-    wheelTimer_->cancelAll();
-    eventBase_.terminateLoopSoon();
-  });
-  thread_.join();
-}
-
-Future<Unit> ThreadWheelTimekeeper::after(Duration dur) {
-  auto cob = WTCallback::create(&eventBase_);
-  auto f = cob->getFuture();
-  eventBase_.runInEventBaseThread([=]{
-    wheelTimer_->scheduleTimeout(cob, dur);
-  });
-  return f;
-}
-
-Timekeeper* getTimekeeperSingleton() {
-  return timekeeperSingleton_.get();
-}
-
-}} // folly::detail
diff --git a/folly/futures/detail/ThreadWheelTimekeeper.h b/folly/futures/detail/ThreadWheelTimekeeper.h
deleted file mode 100644 (file)
index 9625de7..0000000
+++ /dev/null
@@ -1,50 +0,0 @@
-/*
- * Copyright 2015 Facebook, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#pragma once
-
-#include <folly/futures/Future.h>
-#include <folly/futures/Timekeeper.h>
-#include <folly/io/async/EventBase.h>
-#include <folly/io/async/HHWheelTimer.h>
-#include <thread>
-
-namespace folly { namespace detail {
-
-/// The default Timekeeper implementation which uses a HHWheelTimer on an
-/// EventBase in a dedicated thread. Users needn't deal with this directly, it
-/// is used by default by Future methods that work with timeouts.
-class ThreadWheelTimekeeper : public Timekeeper {
- public:
-  /// But it doesn't *have* to be a singleton.
-  ThreadWheelTimekeeper();
-  ~ThreadWheelTimekeeper() override;
-
-  /// Implement the Timekeeper interface
-  /// This future *does* complete on the timer thread. You should almost
-  /// certainly follow it with a via() call or the accuracy of other timers
-  /// will suffer.
-  Future<Unit> after(Duration) override;
-
- protected:
-  folly::EventBase eventBase_;
-  std::thread thread_;
-  HHWheelTimer::UniquePtr wheelTimer_;
-};
-
-Timekeeper* getTimekeeperSingleton();
-
-}} // folly::detail