osmscout::Breaker Class Reference

A breaker object instance allows to trigger cancelation of long running processes. More...

#include <Breaker.h>

Inheritance diagram for osmscout::Breaker:

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

Detailed Description

A breaker object instance allows to trigger cancelation of long running processes.

Constructor & Destructor Documentation

~Breaker()

virtual osmscout::Breaker::~Breaker ( )

virtualdefault

Member Function Documentation

Break()

virtual void osmscout::Breaker::Break ( )

pure 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

Implemented in osmscout::ThreadedBreaker, and osmscout::CancelableFuture< T >::FutureBreaker.

IsAborted()

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

pure virtual

Return true, if the process was signaled to stop.

Returns

True, if signaled, else false

Implemented in osmscout::ThreadedBreaker, and osmscout::CancelableFuture< T >::FutureBreaker.

Reset()

virtual void osmscout::Breaker::Reset ( )

pure virtual

Reset the state of the breaker.

Implemented in osmscout::ThreadedBreaker, and osmscout::CancelableFuture< T >::FutureBreaker.

---

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

• Breaker.h