folly/io/async/ScopedEventBaseThread.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 <memory>
  20 #include <thread>
  21 #include <folly/io/async/EventBase.h>
  22 #include <folly/io/async/EventBaseManager.h>
  23
  24 namespace folly {
  25
  26 /**
  27  * A helper class to start a new thread running a EventBase loop.
  28  *
  29  * The new thread will be started by the ScopedEventBaseThread constructor.
  30  * When the ScopedEventBaseThread object is destroyed, the thread will be
  31  * stopped.
  32  */
  33 class ScopedEventBaseThread {
  34  public:
  35   explicit ScopedEventBaseThread(
  36       bool autostart = true,
  37       EventBaseManager* ebm = nullptr);
  38   explicit ScopedEventBaseThread(
  39       EventBaseManager* ebm);
  40   ~ScopedEventBaseThread();
  41
  42   ScopedEventBaseThread(ScopedEventBaseThread&& other) noexcept;
  43   ScopedEventBaseThread &operator=(ScopedEventBaseThread&& other) noexcept;
  44
  45   /**
  46    * Get a pointer to the EventBase driving this thread.
  47    */
  48   EventBase* getEventBase() const {
  49     return eventBase_.get();
  50   }
  51
  52   void start();
  53   void stop();
  54   bool running();
  55
  56  private:
  57   ScopedEventBaseThread(const ScopedEventBaseThread& other) = delete;
  58   ScopedEventBaseThread& operator=(const ScopedEventBaseThread& other) = delete;
  59
  60   EventBaseManager* ebm_;
  61   std::unique_ptr<EventBase> eventBase_;
  62   std::unique_ptr<std::thread> thread_;
  63 };
  64
  65 }