osmscout::AsyncWorker Class Reference

Async worker provides simple tool for providing asynchronous method calls. More...

#include <AsyncWorker.h>

Public Member Functions
	AsyncWorker (AsyncWorker &&)=delete
	AsyncWorker (const AsyncWorker &)=delete
	AsyncWorker (const std::string &name)
void	DeleteLater ()
std::thread::id	GetThreadId () const
void	Loop ()
AsyncWorker &	operator= (AsyncWorker &&)=delete
AsyncWorker &	operator= (const AsyncWorker &)=delete
void	ThreadAssert () const
virtual	~AsyncWorker ()

Protected Member Functions
template<typename T >
CancelableFuture< T >	Async (const std::function< T(Breaker &)> &task)

Detailed Description

Async worker provides simple tool for providing asynchronous method calls.

Functions executed via Async method are executed in contex of worker thread. If all class fields are modified in context of worker thread, there is no need of synchronisation.

Constructor & Destructor Documentation

AsyncWorker() [1/3]

osmscout::AsyncWorker::AsyncWorker ( const std::string &  name )

explicit

References osmscout::SetThreadName().

~AsyncWorker()

osmscout::AsyncWorker::~AsyncWorker ( )

virtual

References osmscout::ProcessingQueue< T >::Stop().

AsyncWorker() [2/3]

osmscout::AsyncWorker::AsyncWorker ( const AsyncWorker &  )

delete

AsyncWorker() [3/3]

osmscout::AsyncWorker::AsyncWorker ( AsyncWorker &&  )

delete

Member Function Documentation

Async()

template<typename T >

CancelableFuture<T> osmscout::AsyncWorker::Async ( const std::function< T(Breaker &)> &  task )

inlineprotected

References osmscout::CancelableFuture< T >::Promise::Breaker(), osmscout::CancelableFuture< T >::Promise::Future(), and osmscout::CancelableFuture< T >::Promise::SetValue().

DeleteLater()

void osmscout::AsyncWorker::DeleteLater

(

)

References osmscout::ProcessingQueue< T >::Stop().

GetThreadId()

std::thread::id osmscout::AsyncWorker::GetThreadId ( ) const

inline

Loop()

void osmscout::AsyncWorker::Loop

(

)

References osmscout::ProcessingQueue< T >::Finished(), and osmscout::ProcessingQueue< T >::PopTask().

operator=() [1/2]

AsyncWorker& osmscout::AsyncWorker::operator= ( AsyncWorker &&  )

delete

operator=() [2/2]

AsyncWorker& osmscout::AsyncWorker::operator= ( const AsyncWorker &  )

delete

ThreadAssert()

void osmscout::AsyncWorker::ThreadAssert ( ) const

inline

---

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

• AsyncWorker.h
• AsyncWorker.cpp