osmscout::CancelableFuture< T >::FutureBreaker Class Reference

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

Inheritance diagram for osmscout::CancelableFuture< T >::FutureBreaker:

Collaboration diagram for osmscout::CancelableFuture< T >::FutureBreaker:

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

Friends
class	Promise

Constructor & Destructor Documentation

~FutureBreaker()

template<typename T>

virtual osmscout::CancelableFuture< T >::FutureBreaker::~FutureBreaker ( )

virtualdefault

FutureBreaker() [1/2]

template<typename T>

osmscout::CancelableFuture< T >::FutureBreaker::FutureBreaker ( const FutureBreaker & )

default

FutureBreaker() [2/2]

template<typename T>

osmscout::CancelableFuture< T >::FutureBreaker::FutureBreaker ( FutureBreaker && )

default

Member Function Documentation

Break()

template<typename T>

void osmscout::CancelableFuture< T >::FutureBreaker::Break ( )

inlineoverridevirtual

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()

template<typename T>

bool osmscout::CancelableFuture< T >::FutureBreaker::IsAborted ( ) const

inlineoverridevirtual

Return true, if the process was signaled to stop

Returns

True, if signaled, else false

Implements osmscout::Breaker.

operator=() [1/2]

template<typename T>

FutureBreaker & osmscout::CancelableFuture< T >::FutureBreaker::operator= ( const FutureBreaker & )

default

operator=() [2/2]

template<typename T>

FutureBreaker & osmscout::CancelableFuture< T >::FutureBreaker::operator= ( FutureBreaker && )

default

Reset()

template<typename T>

void osmscout::CancelableFuture< T >::FutureBreaker::Reset ( )

inlineoverridevirtual

Reset the state of the breaker.

Implements osmscout::Breaker.

Friends And Related Symbol Documentation

Promise

template<typename T>

friend class Promise

friend

---

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

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