folly/wangle/concurrent/IOExecutor.h

   1 /*
   2  * Copyright 2015 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 <atomic>
  20 #include <folly/Executor.h>
  21
  22 namespace folly {
  23 class EventBase;
  24 }
  25
  26 namespace folly { namespace wangle {
  27
  28 // An IOExecutor is an executor that operates on at least one EventBase.  One of
  29 // these EventBases should be accessible via getEventBase(). The event base
  30 // returned by a call to getEventBase() is implementation dependent.
  31 //
  32 // Note that IOExecutors don't necessarily loop on the base themselves - for
  33 // instance, EventBase itself is an IOExecutor but doesn't drive itself.
  34 //
  35 // Implementations of IOExecutor are eligible to become the global IO executor,
  36 // returned on every call to getIOExecutor(), via setIOExecutor().
  37 // These functions are declared in GlobalExecutor.h
  38 //
  39 // If getIOExecutor is called and none has been set, a default global
  40 // IOThreadPoolExecutor will be created and returned.
  41 class IOExecutor : public virtual Executor {
  42  public:
  43   virtual ~IOExecutor() {}
  44   virtual EventBase* getEventBase() = 0;
  45 };
  46
  47 }}