folly/wangle/Executor.h

   1 /*
   2  * Copyright 2014 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 <boost/noncopyable.hpp>
  20 #include <chrono>
  21 #include <functional>
  22 #include <memory>
  23
  24 namespace folly { namespace wangle {
  25   /// An Executor accepts units of work with add(), which should be
  26   /// threadsafe.
  27   /// Like an Rx Scheduler. We should probably rename it to match now that it
  28   /// has scheduling semantics too, but that's a codemod for another lazy
  29   /// summer afternoon.
  30   class Executor : boost::noncopyable {
  31    public:
  32      typedef std::function<void()> Action;
  33      // Reality is that better than millisecond resolution is very hard to
  34      // achieve. However, we reserve the right to be incredible.
  35      typedef std::chrono::microseconds Duration;
  36      typedef std::chrono::steady_clock::time_point TimePoint;
  37
  38      virtual ~Executor() = default;
  39
  40      /// Enqueue an action to be performed by this executor. This and all
  41      /// schedule variants must be threadsafe.
  42      virtual void add(Action&&) = 0;
  43
  44      /// A convenience function for shared_ptr to legacy functors.
  45      ///
  46      /// Sometimes you have a functor that is move-only, and therefore can't be
  47      /// converted to a std::function (e.g. std::packaged_task). In that case,
  48      /// wrap it in a shared_ptr (or maybe folly::MoveWrapper) and use this.
  49      template <class P>
  50      void addPtr(P fn) {
  51        this->add([fn]() mutable { (*fn)(); });
  52      }
  53
  54      /// Alias for add() (for Rx consistency)
  55      void schedule(Action&& a) { add(std::move(a)); }
  56
  57      /// Schedule an action to be executed after dur time has elapsed
  58      /// Expect millisecond resolution at best.
  59      void schedule(Action&& a, Duration const& dur) {
  60        scheduleAt(std::move(a), now() + dur);
  61      }
  62
  63      /// Schedule an action to be executed at time t, or as soon afterward as
  64      /// possible. Expect millisecond resolution at best. Must be threadsafe.
  65      virtual void scheduleAt(Action&& a, TimePoint const& t) {
  66        throw std::logic_error("unimplemented");
  67      }
  68
  69      /// Get this executor's notion of time. Must be threadsafe.
  70      virtual TimePoint now() {
  71        return std::chrono::steady_clock::now();
  72      }
  73   };
  74 }}