folly/fibers/LoopController.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 #pragma once
  17
  18 #include <chrono>
  19 #include <functional>
  20
  21 namespace folly {
  22 namespace fibers {
  23
  24 class FiberManager;
  25
  26 class LoopController {
  27  public:
  28   typedef std::chrono::steady_clock Clock;
  29   typedef std::chrono::time_point<Clock> TimePoint;
  30
  31   virtual ~LoopController() {}
  32
  33   /**
  34    * Called by FiberManager to associate itself with the LoopController.
  35    */
  36   virtual void setFiberManager(FiberManager*) = 0;
  37
  38   /**
  39    * Called by FiberManager to schedule the loop function run
  40    * at some point in the future.
  41    */
  42   virtual void schedule() = 0;
  43
  44   /**
  45    * Run FiberManager loopUntilNoReadyImpl(). May have additional logic specific
  46    * to a LoopController.
  47    */
  48   virtual void runLoop() = 0;
  49
  50   /**
  51    * Same as schedule(), but safe to call from any thread.
  52    * Runs func and only schedules if func returned true.
  53    */
  54   virtual void scheduleThreadSafe(std::function<bool()> func) = 0;
  55
  56   /**
  57    * Called by FiberManager to cancel a previously scheduled
  58    * loop function run.
  59    */
  60   virtual void cancel() = 0;
  61
  62   /**
  63    * Called by FiberManager to schedule some function to be run at some time.
  64    */
  65   virtual void timedSchedule(std::function<void()> func, TimePoint time) = 0;
  66 };
  67 } // namespace fibers
  68 } // namespace folly