folly/io/async/ScopedEventBaseThread.h

   1 /*
   2  * Copyright 2015-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 #include <thread>
  21
  22 #include <folly/io/async/EventBase.h>
  23 #include <folly/synchronization/Baton.h>
  24
  25 namespace folly {
  26
  27 class EventBaseManager;
  28 template <class Iter>
  29 class Range;
  30 typedef Range<const char*> StringPiece;
  31
  32 /**
  33  * A helper class to start a new thread running a EventBase loop.
  34  *
  35  * The new thread will be started by the ScopedEventBaseThread constructor.
  36  * When the ScopedEventBaseThread object is destroyed, the thread will be
  37  * stopped.
  38  */
  39 class ScopedEventBaseThread {
  40  public:
  41   ScopedEventBaseThread();
  42   explicit ScopedEventBaseThread(const StringPiece& name);
  43   explicit ScopedEventBaseThread(EventBaseManager* ebm);
  44   explicit ScopedEventBaseThread(
  45       EventBaseManager* ebm,
  46       const StringPiece& name);
  47   ~ScopedEventBaseThread();
  48
  49   EventBase* getEventBase() const {
  50     return &eb_;
  51   }
  52
  53   std::thread::id getThreadId() const {
  54     return th_.get_id();
  55   }
  56
  57  private:
  58   ScopedEventBaseThread(ScopedEventBaseThread&& other) = delete;
  59   ScopedEventBaseThread& operator=(ScopedEventBaseThread&& other) = delete;
  60
  61   ScopedEventBaseThread(const ScopedEventBaseThread& other) = delete;
  62   ScopedEventBaseThread& operator=(const ScopedEventBaseThread& other) = delete;
  63
  64   EventBaseManager* ebm_;
  65   union {
  66     mutable EventBase eb_;
  67   };
  68   std::thread th_;
  69   folly::Baton<> stop_;
  70 };
  71
  72 } // namespace folly