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> | |
15 | |
16 #include "webrtc/typedefs.h" | 14 #include "webrtc/typedefs.h" |
| 15 #include "webrtc/base/scoped_ptr.h" |
17 | 16 |
18 namespace webrtc { | 17 namespace webrtc { |
19 class Module; | 18 class Module; |
20 | 19 |
21 class ProcessTask { | 20 class ProcessTask { |
22 public: | 21 public: |
23 ProcessTask() {} | 22 ProcessTask() {} |
24 virtual ~ProcessTask() {} | 23 virtual ~ProcessTask() {} |
25 | 24 |
26 virtual void Run() = 0; | 25 virtual void Run() = 0; |
27 }; | 26 }; |
28 | 27 |
29 class ProcessThread { | 28 class ProcessThread { |
30 public: | 29 public: |
31 virtual ~ProcessThread(); | 30 virtual ~ProcessThread(); |
32 | 31 |
33 static std::unique_ptr<ProcessThread> Create(const char* thread_name); | 32 static rtc::scoped_ptr<ProcessThread> Create(const char* thread_name); |
34 | 33 |
35 // Starts the worker thread. Must be called from the construction thread. | 34 // Starts the worker thread. Must be called from the construction thread. |
36 virtual void Start() = 0; | 35 virtual void Start() = 0; |
37 | 36 |
38 // Stops the worker thread. Must be called from the construction thread. | 37 // Stops the worker thread. Must be called from the construction thread. |
39 virtual void Stop() = 0; | 38 virtual void Stop() = 0; |
40 | 39 |
41 // Wakes the thread up to give a module a chance to do processing right | 40 // 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 | 41 // 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 | 42 // module for when it should be called back. (Typically the module should |
44 // return 0 from TimeUntilNextProcess on the worker thread at that point). | 43 // return 0 from TimeUntilNextProcess on the worker thread at that point). |
45 // Can be called on any thread. | 44 // Can be called on any thread. |
46 virtual void WakeUp(Module* module) = 0; | 45 virtual void WakeUp(Module* module) = 0; |
47 | 46 |
48 // Queues a task object to run on the worker thread. Ownership of the | 47 // 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 | 48 // task object is transferred to the ProcessThread and the object will |
50 // either be deleted after running on the worker thread, or on the | 49 // either be deleted after running on the worker thread, or on the |
51 // construction thread of the ProcessThread instance, if the task did not | 50 // 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 | 51 // get a chance to run (e.g. posting the task while shutting down or when |
53 // the thread never runs). | 52 // the thread never runs). |
54 virtual void PostTask(std::unique_ptr<ProcessTask> task) = 0; | 53 virtual void PostTask(rtc::scoped_ptr<ProcessTask> task) = 0; |
55 | 54 |
56 // Adds a module that will start to receive callbacks on the worker thread. | 55 // Adds a module that will start to receive callbacks on the worker thread. |
57 // Can be called from any thread. | 56 // Can be called from any thread. |
58 virtual void RegisterModule(Module* module) = 0; | 57 virtual void RegisterModule(Module* module) = 0; |
59 | 58 |
60 // Removes a previously registered module. | 59 // Removes a previously registered module. |
61 // Can be called from any thread. | 60 // Can be called from any thread. |
62 virtual void DeRegisterModule(Module* module) = 0; | 61 virtual void DeRegisterModule(Module* module) = 0; |
63 }; | 62 }; |
64 | 63 |
65 } // namespace webrtc | 64 } // namespace webrtc |
66 | 65 |
67 #endif // WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ | 66 #endif // WEBRTC_MODULES_UTILITY_INCLUDE_PROCESS_THREAD_H_ |
OLD | NEW |