Remove multi-poster support from Baton
[folly.git] / folly / stop_watch.h
index bc01935a8a0156829ca8eed9a7717fe37eb5f64d..5bac22a2e373a2e9e462f0267d81cf4ed72a9e7f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -62,9 +62,9 @@ using monotonic_clock = std::chrono::steady_clock;
  *
  * Example 1:
  *
- *  coarse_stop_watch<std::seconds> watch;
+ *  coarse_stop_watch<std::chrono::seconds> watch;
  *  do_something();
- *  std::cout << "time elapsed: " << watch.elapsed() << std::endl;
+ *  std::cout << "time elapsed: " << watch.elapsed().count() << std::endl;
  *
  *  auto const ttl = 60_s;
  *  if (watch.elapsed(ttl)) {
@@ -271,6 +271,13 @@ struct custom_stop_watch {
     return true;
   }
 
+  /**
+   * Returns the current checkpoint
+   */
+  typename clock_type::time_point getCheckpoint() const {
+    return checkpoint_;
+  }
+
  private:
   typename clock_type::time_point checkpoint_;
 };
@@ -286,9 +293,9 @@ struct custom_stop_watch {
  *
  * Example:
  *
- *  coarse_stop_watch<std::seconds> watch;
+ *  coarse_stop_watch<std::chrono::seconds> watch;
  *  do_something();
- *  std::cout << "time elapsed: " << watch.elapsed() << std::endl;
+ *  std::cout << "time elapsed: " << watch.elapsed().count() << std::endl;
  *
  * @author: Marcelo Juchem <marcelo@fb.com>
  */
@@ -306,12 +313,12 @@ using coarse_stop_watch = custom_stop_watch<monotonic_coarse_clock, Duration>;
  *
  * Example:
  *
- *  stop_watch<std::seconds> watch;
+ *  stop_watch<std::chrono::seconds> watch;
  *  do_something();
- *  std::cout << "time elapsed: " << watch.elapsed() << std::endl;
+ *  std::cout << "time elapsed: " << watch.elapsed().count() << std::endl;
  *
  * @author: Marcelo Juchem <marcelo@fb.com>
  */
 template <typename Duration = monotonic_clock::duration>
 using stop_watch = custom_stop_watch<monotonic_clock, Duration>;
-}
+} // namespace folly