folly/Executor.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 <climits>
  20
  21 #include <folly/Function.h>
  22
  23 namespace folly {
  24
  25 using Func = Function<void()>;
  26
  27 /// An Executor accepts units of work with add(), which should be
  28 /// threadsafe.
  29 class Executor {
  30  public:
  31   virtual ~Executor() = default;
  32
  33   /// Enqueue a function to executed by this executor. This and all
  34   /// variants must be threadsafe.
  35   virtual void add(Func) = 0;
  36
  37   /// Enqueue a function with a given priority, where 0 is the medium priority
  38   /// This is up to the implementation to enforce
  39   virtual void addWithPriority(Func, int8_t priority);
  40
  41   virtual uint8_t getNumPriorities() const {
  42     return 1;
  43   }
  44
  45   static const int8_t LO_PRI  = SCHAR_MIN;
  46   static const int8_t MID_PRI = 0;
  47   static const int8_t HI_PRI  = SCHAR_MAX;
  48
  49   class KeepAlive {
  50    public:
  51     KeepAlive() {}
  52
  53     void reset() {
  54       executor_.reset();
  55     }
  56
  57     explicit operator bool() const {
  58       return executor_ != nullptr;
  59     }
  60
  61    private:
  62     friend class Executor;
  63     explicit KeepAlive(folly::Executor* executor) : executor_(executor) {}
  64
  65     struct Deleter {
  66       void operator()(folly::Executor* executor) {
  67         executor->keepAliveRelease();
  68       }
  69     };
  70     std::unique_ptr<folly::Executor, Deleter> executor_;
  71   };
  72
  73   /// Returns a keep-alive token which guarantees that Executor will keep
  74   /// processing tasks until the token is released.
  75   ///
  76   /// If executor does not support keep-alive functionality - dummy token will
  77   /// be returned.
  78   virtual KeepAlive getKeepAliveToken() {
  79     return {};
  80   }
  81
  82  protected:
  83   virtual void keepAliveAcquire();
  84   virtual void keepAliveRelease();
  85
  86   KeepAlive makeKeepAlive() {
  87     return KeepAlive{this};
  88   }
  89 };
  90
  91 } // namespace folly