osmscout::ThreadedBreaker Class Reference

#include <libosmscout/include/osmscout/async/Breaker.h>

Inheritance diagram for osmscout::ThreadedBreaker:

Collaboration diagram for osmscout::ThreadedBreaker:

Public Member Functions
	ThreadedBreaker ()=default
void	Break () override
bool	IsAborted () const override
void	Reset () override
Public Member Functions inherited from osmscout::Breaker
virtual	~Breaker ()=default

Constructor & Destructor Documentation

ThreadedBreaker()

osmscout::ThreadedBreaker::ThreadedBreaker ( )

default

Member Function Documentation

Break()

void osmscout::ThreadedBreaker::Break ( )

overridevirtual

Stop the processing. This is just a setting a flag that must actively get polled by the long running process. So while the process was signaled to stop, it can still continue for a while.

Returns

Implements osmscout::Breaker.

IsAborted()

bool osmscout::ThreadedBreaker::IsAborted ( ) const

overridevirtual

Return true, if the process was signaled to stop

Returns

True, if signaled, else false

Implements osmscout::Breaker.

Reset()

void osmscout::ThreadedBreaker::Reset ( )

overridevirtual

Reset the state of the breaker.

Implements osmscout::Breaker.

---

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

• libosmscout/include/osmscout/async/Breaker.h