folly/futures/detail/Types.h

   1 /*
   2  * Copyright 2017 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 <chrono>
  20
  21 namespace folly {
  22
  23 /// folly::Duration is an alias for the best resolution we offer/work with.
  24 /// However, it is not intended to be used for client code - you should use a
  25 /// descriptive std::chrono::duration type instead. e.g. do not write this:
  26 ///
  27 ///   futures::sleep(Duration(1000))...
  28 ///
  29 /// rather this:
  30 ///
  31 ///   futures::sleep(std::chrono::milliseconds(1000));
  32 ///
  33 /// or this:
  34 ///
  35 ///   futures::sleep(std::chrono::seconds(1));
  36 using Duration = std::chrono::milliseconds;
  37
  38 }