libosmscout  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups
osmscout::ThreadedBreaker Class Reference

#include <Breaker.h>

+ Inheritance diagram for osmscout::ThreadedBreaker:

Public Member Functions

virtual void Break ()
 Stop the processing. More...
 
virtual bool IsAborted () const
 Return true, if the process was signaled to stop. More...
 
virtual void Reset ()
 Reset the state of the breaker. More...
 
 ThreadedBreaker ()
 
- Public Member Functions inherited from osmscout::Breaker
virtual ~Breaker ()=default
 

Constructor & Destructor Documentation

osmscout::ThreadedBreaker::ThreadedBreaker ( )

Member Function Documentation

void osmscout::ThreadedBreaker::Break ( )
virtual

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.

bool osmscout::ThreadedBreaker::IsAborted ( ) const
virtual

Return true, if the process was signaled to stop.

Returns
True, if signaled, else false

Implements osmscout::Breaker.

void osmscout::ThreadedBreaker::Reset ( )
virtual

Reset the state of the breaker.

Implements osmscout::Breaker.


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