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 <memory> |
20 | |
21 | #include <folly/Executor.h> |
22 | #include <folly/executors/IOExecutor.h> |
23 | |
24 | namespace folly { |
25 | |
26 | /** |
27 | * Retrieve the global Executor. If there is none, a default InlineExecutor |
28 | * will be constructed and returned. This is named CPUExecutor to distinguish |
29 | * it from IOExecutor below and to hint that it's intended for CPU-bound tasks. |
30 | * |
31 | * Can return nullptr on shutdown. |
32 | */ |
33 | std::shared_ptr<folly::Executor> getCPUExecutor(); |
34 | |
35 | /** |
36 | * Set an Executor to be the global Executor which will be returned by |
37 | * subsequent calls to getCPUExecutor(). |
38 | */ |
39 | void setCPUExecutor(std::weak_ptr<folly::Executor> executor); |
40 | |
41 | /** |
42 | * Retrieve the global IOExecutor. If there is none, a default |
43 | * IOThreadPoolExecutor will be constructed and returned. |
44 | * |
45 | * IOExecutors differ from Executors in that they drive and provide access to |
46 | * one or more EventBases. |
47 | * |
48 | * Can return nullptr on shutdown. |
49 | */ |
50 | std::shared_ptr<IOExecutor> getIOExecutor(); |
51 | |
52 | /** |
53 | * Set an IOExecutor to be the global IOExecutor which will be returned by |
54 | * subsequent calls to getIOExecutor(). |
55 | */ |
56 | void setIOExecutor(std::weak_ptr<IOExecutor> executor); |
57 | |
58 | /** |
59 | * Retrieve an event base from the global IOExecutor |
60 | * |
61 | * NOTE: This is not shutdown-safe, the returned pointer may be |
62 | * invalid during shutdown. |
63 | */ |
64 | folly::EventBase* getEventBase(); |
65 | |
66 | } // namespace folly |
67 | |