OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 4 * Use of this source code is governed by a BSD-style license |
5 * that can be found in the LICENSE file in the root of the source | 5 * that can be found in the LICENSE file in the root of the source |
6 * tree. An additional intellectual property rights grant can be found | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 */ | 9 */ |
10 | 10 |
11 #ifndef WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ | 11 #ifndef WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ |
12 #define WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ | 12 #define WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ |
13 | 13 |
14 #include <memory> | 14 #include <memory> |
15 | 15 |
16 #include "webrtc/typedefs.h" | 16 #include "webrtc/typedefs.h" |
17 | 17 |
| 18 #if defined(WEBRTC_WIN) |
| 19 // Due to a bug in the std::unique_ptr implementation that ships with MSVS, |
| 20 // we need the full definition of QueuedTask, on Windows. |
| 21 #include "webrtc/base/task_queue.h" |
| 22 #else |
| 23 namespace rtc { |
| 24 class QueuedTask; |
| 25 } |
| 26 #endif |
| 27 |
18 namespace webrtc { | 28 namespace webrtc { |
19 class Module; | 29 class Module; |
20 | 30 |
21 class ProcessTask { | 31 // TODO(tommi): ProcessThread probably doesn't need to be a virtual |
22 public: | 32 // interface. There exists one override besides ProcessThreadImpl, |
23 ProcessTask() {} | 33 // MockProcessThread, but when looking at how it is used, it seems |
24 virtual ~ProcessTask() {} | 34 // a nullptr might suffice (or simply an actual ProcessThread instance). |
25 | |
26 virtual void Run() = 0; | |
27 }; | |
28 | |
29 class ProcessThread { | 35 class ProcessThread { |
30 public: | 36 public: |
31 virtual ~ProcessThread(); | 37 virtual ~ProcessThread(); |
32 | 38 |
33 static std::unique_ptr<ProcessThread> Create(const char* thread_name); | 39 static std::unique_ptr<ProcessThread> Create(const char* thread_name); |
34 | 40 |
35 // Starts the worker thread. Must be called from the construction thread. | 41 // Starts the worker thread. Must be called from the construction thread. |
36 virtual void Start() = 0; | 42 virtual void Start() = 0; |
37 | 43 |
38 // Stops the worker thread. Must be called from the construction thread. | 44 // Stops the worker thread. Must be called from the construction thread. |
39 virtual void Stop() = 0; | 45 virtual void Stop() = 0; |
40 | 46 |
41 // Wakes the thread up to give a module a chance to do processing right | 47 // Wakes the thread up to give a module a chance to do processing right |
42 // away. This causes the worker thread to wake up and requery the specified | 48 // away. This causes the worker thread to wake up and requery the specified |
43 // module for when it should be called back. (Typically the module should | 49 // module for when it should be called back. (Typically the module should |
44 // return 0 from TimeUntilNextProcess on the worker thread at that point). | 50 // return 0 from TimeUntilNextProcess on the worker thread at that point). |
45 // Can be called on any thread. | 51 // Can be called on any thread. |
46 virtual void WakeUp(Module* module) = 0; | 52 virtual void WakeUp(Module* module) = 0; |
47 | 53 |
48 // Queues a task object to run on the worker thread. Ownership of the | 54 // Queues a task object to run on the worker thread. Ownership of the |
49 // task object is transferred to the ProcessThread and the object will | 55 // task object is transferred to the ProcessThread and the object will |
50 // either be deleted after running on the worker thread, or on the | 56 // either be deleted after running on the worker thread, or on the |
51 // construction thread of the ProcessThread instance, if the task did not | 57 // construction thread of the ProcessThread instance, if the task did not |
52 // get a chance to run (e.g. posting the task while shutting down or when | 58 // get a chance to run (e.g. posting the task while shutting down or when |
53 // the thread never runs). | 59 // the thread never runs). |
54 virtual void PostTask(std::unique_ptr<ProcessTask> task) = 0; | 60 virtual void PostTask(std::unique_ptr<rtc::QueuedTask> task) = 0; |
55 | 61 |
56 // Adds a module that will start to receive callbacks on the worker thread. | 62 // Adds a module that will start to receive callbacks on the worker thread. |
57 // Can be called from any thread. | 63 // Can be called from any thread. |
58 virtual void RegisterModule(Module* module) = 0; | 64 virtual void RegisterModule(Module* module) = 0; |
59 | 65 |
60 // Removes a previously registered module. | 66 // Removes a previously registered module. |
61 // Can be called from any thread. | 67 // Can be called from any thread. |
62 virtual void DeRegisterModule(Module* module) = 0; | 68 virtual void DeRegisterModule(Module* module) = 0; |
63 }; | 69 }; |
64 | 70 |
65 } // namespace webrtc | 71 } // namespace webrtc |
66 | 72 |
67 #endif // WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ | 73 #endif // WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ |
OLD | NEW |