ThreadPool-inl.h
Go to the documentation of this file.
1 // This file is a part of the OpenSurgSim project.
2 // Copyright 2013, SimQuest Solutions 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 #ifndef SURGSIM_FRAMEWORK_THREADPOOL_INL_H
17 #define SURGSIM_FRAMEWORK_THREADPOOL_INL_H
18 
19 
20 namespace SurgSim
21 {
22 namespace Framework
23 {
24 
26 {
27 public:
28  virtual void execute() = 0;
29 
30  virtual ~TaskBase() {}
31 };
32 
33 template<class R>
35 {
36 public:
37  explicit Task(std::function<R()> function) :
38  m_task(function)
39  {
40  }
41 
42  void execute() override
43  {
44  m_task();
45  }
46 
47  std::future<R> getFuture()
48  {
49  return m_task.get_future();
50  }
51 
52 private:
53  std::packaged_task<R()> m_task;
54 };
55 
56 template <class R>
57 std::future<R> ThreadPool::enqueue(std::function<R()> function)
58 {
59  std::unique_ptr<Task<R>> task = std::unique_ptr<Task<R>>(new Task<R>(function));
60  std::future<R> future = task->getFuture();
61  {
62  boost::unique_lock<boost::mutex> lock(m_mutex);
63  m_tasks.push(std::move(task));
64  }
65  m_threadSignaler.notify_one();
66  return future;
67 }
68 
69 };
70 };
71 
72 #endif //SURGSIM_FRAMEWORK_THREADPOOL_INL_H
73 
74 
SurgSim::Framework::ThreadPool::Task::execute
void execute() override
Definition: ThreadPool-inl.h:42
SurgSim::Framework::ThreadPool::Task
Actual tasks, with typed return type.
Definition: ThreadPool-inl.h:34
SurgSim::Framework::ThreadPool::TaskBase::~TaskBase
virtual ~TaskBase()
Definition: ThreadPool-inl.h:30
SurgSim::Framework::ThreadPool::TaskBase
Definition: ThreadPool-inl.h:25
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
SurgSim::Framework::ThreadPool::m_mutex
boost::mutex m_mutex
Mutex for protecting the tasks queue.
Definition: ThreadPool.h:105
SurgSim::Framework::ThreadPool::Task::Task
Task(std::function< R()> function)
Definition: ThreadPool-inl.h:37
SurgSim::Framework::ThreadPool::m_threadSignaler
boost::condition_variable m_threadSignaler
Signaler for waking up threads waiting for tasks.
Definition: ThreadPool.h:108
SurgSim::Framework::ThreadPool::Task::m_task
std::packaged_task< R()> m_task
Definition: ThreadPool-inl.h:53
SurgSim::Framework::ThreadPool::TaskBase::execute
virtual void execute()=0
SurgSim::Framework::ThreadPool::Task::getFuture
std::future< R > getFuture()
Definition: ThreadPool-inl.h:47
SurgSim::Framework::ThreadPool::enqueue
std::future< R > enqueue(std::function< R()> function)
Queue a task to be run by the ThreadPool.
Definition: ThreadPool-inl.h:57
SurgSim::Framework::ThreadPool::m_tasks
std::queue< std::unique_ptr< TaskBase > > m_tasks
Queued tasks waiting for an available thread.
Definition: ThreadPool.h:102