ThreadPool-inl.h
Go to the documentation of this file.
// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SURGSIM_FRAMEWORK_THREADPOOL_INL_H
#define SURGSIM_FRAMEWORK_THREADPOOL_INL_H
namespace SurgSim
{
namespace Framework
{
class ThreadPool::TaskBase
{
public:
virtual void execute() = 0;
virtual ~TaskBase() {}
};
template<class R>
class ThreadPool::Task : public ThreadPool::TaskBase
{
public:
explicit Task(std::function<R()> function) :
m_task(function)
{
}
void execute() override
{
m_task();
}
std::future<R> getFuture()
{
return m_task.get_future();
}
private:
std::packaged_task<R()> m_task;
};
template <class R>
std::future<R> ThreadPool::enqueue(std::function<R()> function)
{
std::unique_ptr<Task<R>> task = std::unique_ptr<Task<R>>(new Task<R>(function));
std::future<R> future = task->getFuture();
{
boost::unique_lock<boost::mutex> lock(m_mutex);
m_tasks.push(std::move(task));
}
m_threadSignaler.notify_one();
return future;
}
};
};
#endif //SURGSIM_FRAMEWORK_THREADPOOL_INL_H
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
SurgSim::Framework::ThreadPool::Task
Actual tasks, with typed return type.
Definition: ThreadPool-inl.h:34
SurgSim::Framework::ThreadPool::TaskBase
Definition: ThreadPool-inl.h:25
SurgSim::Framework::ThreadPool::Task::m_task
std::packaged_task< R()> m_task
Definition: ThreadPool-inl.h:53
SurgSim::Framework::ThreadPool::m_tasks
std::queue< std::unique_ptr< TaskBase > > m_tasks
Queued tasks waiting for an available thread.
Definition: ThreadPool.h:102
SurgSim::Framework::ThreadPool::TaskBase::~TaskBase
virtual ~TaskBase()
Definition: ThreadPool-inl.h:30
SurgSim::Framework::ThreadPool::Task::Task
Task(std::function< R()> function)
Definition: ThreadPool-inl.h:37
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::Task::execute
void execute() override
Definition: ThreadPool-inl.h:42
SurgSim::Framework::ThreadPool::TaskBase::execute
virtual void execute()=0
SurgSim::Framework::ThreadPool::m_mutex
boost::mutex m_mutex
Mutex for protecting the tasks queue.
Definition: ThreadPool.h:105
SurgSim::Framework::ThreadPool::Task::getFuture
std::future< R > getFuture()
Definition: ThreadPool-inl.h:47
SurgSim::Framework::ThreadPool::m_threadSignaler
boost::condition_variable m_threadSignaler
Signaler for waking up threads waiting for tasks.
Definition: ThreadPool.h:108