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