knowrob::ThreadPool::Runner Class Reference

#include <ThreadPool.h>

Inheritance diagram for knowrob::ThreadPool::Runner:

Public Member Functions
	Runner ()
virtual	~Runner ()
	Runner (const Runner &)=delete
void	join ()
virtual void	run ()=0
void	stop (bool wait)
bool	hasStopRequest () const
bool	isTerminated () const
	Runner ()
virtual	~Runner ()
	Runner (const Runner &)=delete
void	join ()
virtual void	run ()=0
void	stop (bool wait)
bool	hasStopRequest () const
bool	isTerminated () const

Protected Member Functions
void	runInternal ()
void	setExceptionHandler (ExceptionHandler exceptionHandler)
void	runInternal ()
void	setExceptionHandler (ExceptionHandler exceptionHandler)

Protected Attributes
std::atomic< bool >	isTerminated_
std::atomic< bool >	isRunning_
std::atomic< bool >	hasStopRequest_
std::mutex	mutex_
std::condition_variable	finishedCV_
ExceptionHandler	exceptionHandler_

Friends
class	ThreadPool::Worker
class	ThreadPool

Detailed Description

An object that provides a run function which is evaluated in a worker thread.

Definition at line 93 of file ThreadPool.h.

Constructor & Destructor Documentation

Runner() [1/4]

ThreadPool::Runner::Runner

(

)

Definition at line 161 of file ThreadPool.cpp.

        : isTerminated_(false),
          isRunning_(false),
          hasStopRequest_(false),
          exceptionHandler_(nullptr) {}

~Runner() [1/2]

ThreadPool::Runner::~Runner ( )

virtual

Definition at line 167 of file ThreadPool.cpp.

                          {
    if (isRunning_) stop(true);
}

Runner() [2/4]

knowrob::ThreadPool::Runner::Runner ( const Runner &  )

delete

Cannot be copy-assigned.

Runner() [3/4]

knowrob::ThreadPool::Runner::Runner

(

)

~Runner() [2/2]

virtual knowrob::ThreadPool::Runner::~Runner ( )

virtual

Runner() [4/4]

knowrob::ThreadPool::Runner::Runner ( const Runner &  )

delete

Cannot be copy-assigned.

Member Function Documentation

hasStopRequest() [1/2]

bool knowrob::ThreadPool::Runner::hasStopRequest ( ) const

inline

Returns

true if the runner was requested to stop.

Definition at line 123 of file ThreadPool.h.

{ return hasStopRequest_; }

hasStopRequest() [2/2]

bool knowrob::ThreadPool::Runner::hasStopRequest ( ) const

inline

Returns

true if the runner was requested to stop.

Definition at line 123 of file ThreadPool.h.

{ return hasStopRequest_; }

isTerminated() [1/2]

bool knowrob::ThreadPool::Runner::isTerminated ( ) const

inline

Returns

true if the runner is still active.

Definition at line 128 of file ThreadPool.h.

{ return isTerminated_; }

isTerminated() [2/2]

bool knowrob::ThreadPool::Runner::isTerminated ( ) const

inline

Returns

true if the runner is still active.

Definition at line 128 of file ThreadPool.h.

{ return isTerminated_; }

join() [1/2]

void ThreadPool::Runner::join

(

)

Wait until run function has exited.

Definition at line 171 of file ThreadPool.cpp.

                            {
    if (!isTerminated()) {
        std::unique_lock<std::mutex> lk(mutex_);
        finishedCV_.wait(lk, [this] { return isTerminated(); });
    }
}

join() [2/2]

void knowrob::ThreadPool::Runner::join

(

)

Wait until run function has exited.

run() [1/2]

virtual void knowrob::ThreadPool::Runner::run ( )

pure virtual

Run the computation in a worker thread.

Implemented in knowrob::ThreadPool::LambdaRunner, knowrob::ReasonerRunner, knowrob::ThreadPool::LambdaRunner, and knowrob::ReasonerRunner.

run() [2/2]

virtual void knowrob::ThreadPool::Runner::run ( )

pure virtual

Run the computation in a worker thread.

Implemented in knowrob::ThreadPool::LambdaRunner, knowrob::ReasonerRunner, knowrob::ThreadPool::LambdaRunner, and knowrob::ReasonerRunner.

runInternal() [1/2]

void ThreadPool::Runner::runInternal ( )

protected

Definition at line 178 of file ThreadPool.cpp.

                                   {
    isRunning_ = true;
    isTerminated_ = false;
    hasStopRequest_ = false;
    // do the work
    try {
        run();
    }
    catch (const boost::python::error_already_set &) {
        PythonError py_error;
        if (exceptionHandler_) {
            exceptionHandler_(py_error);
        } else {
            KB_WARN("Worker error in Python code: {}.", py_error.what());
        }
    }
    catch (const std::exception &e) {
        if (exceptionHandler_) {
            exceptionHandler_(e);
        } else {
            KB_WARN("Worker error: {}.", e.what());
        }
    }
    catch (abi::__forced_unwind const &) {
        // this is a forced unwind, rethrow. this happens when the thread is cancelled.
        KB_WARN("Worker forced unwind.");
        throw;
    }
    catch (...) {
        KB_WARN("Unknown worker error.");
    }
    // toggle flag
    isTerminated_ = true;
    isRunning_ = false;
    finishedCV_.notify_all();
}

runInternal() [2/2]

void knowrob::ThreadPool::Runner::runInternal ( )

protected

setExceptionHandler() [1/2]

void knowrob::ThreadPool::Runner::setExceptionHandler ( ExceptionHandler  exceptionHandler )

inlineprotected

Definition at line 140 of file ThreadPool.h.

{ exceptionHandler_ = exceptionHandler; }

setExceptionHandler() [2/2]

void knowrob::ThreadPool::Runner::setExceptionHandler ( ExceptionHandler  exceptionHandler )

inlineprotected

Definition at line 140 of file ThreadPool.h.

{ exceptionHandler_ = exceptionHandler; }

stop() [1/2]

void ThreadPool::Runner::stop

(

bool

wait

)

Stop the runner.

Parameters

wait	call blocks until runner exited if true.

Definition at line 215 of file ThreadPool.cpp.

                                     {
    // toggle stop request flag on
    hasStopRequest_ = true;
    // wait for the runner to be finished if requested
    if (wait) {
        join();
    }
}

stop() [2/2]

void knowrob::ThreadPool::Runner::stop

(

bool

wait

)

Stop the runner.

Parameters

wait	call blocks until runner exited if true.

Friends And Related Function Documentation

ThreadPool

ThreadPool

friend

Definition at line 144 of file ThreadPool.h.

ThreadPool::Worker

ThreadPool::Worker

friend

Definition at line 142 of file ThreadPool.h.

Member Data Documentation

exceptionHandler_

ExceptionHandler knowrob::ThreadPool::Runner::exceptionHandler_

protected

Definition at line 136 of file ThreadPool.h.

finishedCV_

std::condition_variable knowrob::ThreadPool::Runner::finishedCV_

protected

Definition at line 135 of file ThreadPool.h.

hasStopRequest_

std::atomic< bool > knowrob::ThreadPool::Runner::hasStopRequest_

protected

Definition at line 133 of file ThreadPool.h.

isRunning_

std::atomic< bool > knowrob::ThreadPool::Runner::isRunning_

protected

Definition at line 132 of file ThreadPool.h.

isTerminated_

std::atomic< bool > knowrob::ThreadPool::Runner::isTerminated_

protected

Definition at line 131 of file ThreadPool.h.

mutex_

std::mutex knowrob::ThreadPool::Runner::mutex_

protected

Definition at line 134 of file ThreadPool.h.

---

The documentation for this class was generated from the following files:

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/ThreadPool.h
• src/ThreadPool.cpp