folly/executors/GlobalExecutor.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 <memory>
  20
  21 #include <folly/Executor.h>
  22 #include <folly/executors/IOExecutor.h>
  23
  24 namespace folly {
  25
  26 // Retrieve the global Executor. If there is none, a default InlineExecutor
  27 // will be constructed and returned. This is named CPUExecutor to distinguish
  28 // it from IOExecutor below and to hint that it's intended for CPU-bound tasks.
  29 std::shared_ptr<folly::Executor> getCPUExecutor();
  30
  31 // Set an Executor to be the global Executor which will be returned by
  32 // subsequent calls to getCPUExecutor().
  33 void setCPUExecutor(std::weak_ptr<folly::Executor> executor);
  34
  35 // Retrieve the global IOExecutor. If there is none, a default
  36 // IOThreadPoolExecutor will be constructed and returned.
  37 //
  38 // IOExecutors differ from Executors in that they drive and provide access to
  39 // one or more EventBases.
  40 std::shared_ptr<IOExecutor> getIOExecutor();
  41
  42 // Retrieve an event base from the global IOExecutor
  43 folly::EventBase* getEventBase();
  44
  45 // Set an IOExecutor to be the global IOExecutor which will be returned by
  46 // subsequent calls to getIOExecutor().
  47 void setIOExecutor(std::weak_ptr<IOExecutor> executor);
  48
  49 } // namespace folly