Add TimedDrivableExecutor to folly.
[folly.git] / folly / executors / FiberIOExecutor.h
1 /*
2  * Copyright 2017-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
17 #pragma once
18
19 #include <folly/executors/IOExecutor.h>
20 #include <folly/fibers/FiberManagerMap.h>
21
22 namespace folly {
23
24 /**
25  * @class FiberIOExecutor
26  * @brief An IOExecutor that executes funcs under mapped fiber context
27  *
28  * A FiberIOExecutor wraps an IOExecutor, but executes funcs on the FiberManager
29  * mapped to the underlying IOExector's event base.
30  */
31 class FiberIOExecutor : public IOExecutor {
32  public:
33   explicit FiberIOExecutor(
34       const std::shared_ptr<IOExecutor>& ioExecutor,
35       fibers::FiberManager::Options opts = fibers::FiberManager::Options())
36       : ioExecutor_(ioExecutor), options_(std::move(opts)) {}
37
38   virtual void add(folly::Function<void()> f) override {
39     auto eventBase = ioExecutor_->getEventBase();
40     folly::fibers::getFiberManager(*eventBase, options_).add(std::move(f));
41   }
42
43   virtual folly::EventBase* getEventBase() override {
44     return ioExecutor_->getEventBase();
45   }
46
47  private:
48   std::shared_ptr<IOExecutor> ioExecutor_;
49   fibers::FiberManager::Options options_;
50 };
51
52 } // namespace folly