osmscout::Consumer< E > Class Template Reference

A specialisation of worker that consumes events from a queue. More...

#include <Worker.h>

Inheritance diagram for osmscout::Consumer< E >:

Public Member Functions
	Consumer (ProcessingQueue< E > &inQueue)
Public Member Functions inherited from osmscout::ThreadedWorker
	ThreadedWorker ()=default
	ThreadedWorker (const ThreadedWorker &other)=delete
	ThreadedWorker (ThreadedWorker &&other)=delete
void	Wait ()
bool	WasSuccessful () const
	Returns true if the worker processed successfully, else false.
virtual	~ThreadedWorker ()=default

Protected Attributes
ProcessingQueue< E > &	inQueue

Additional Inherited Members
Protected Member Functions inherited from osmscout::ThreadedWorker
void	MarkWorkerAsFailed ()
	Worker can set itself to the failure status.
virtual void	ProcessingLoop ()=0
void	Start ()

Detailed Description

template<typename E>
class osmscout::Consumer< E >

A specialisation of worker that consumes events from a queue.

The consumer polls the queue and processes the events until the queue is stopped and the remaining events completely consumed.

Template Parameters

E	the event type of the incoming queue

Constructor & Destructor Documentation

Consumer()

template<typename E >

osmscout::Consumer< E >::Consumer ( ProcessingQueue< E > &  inQueue )

inlineexplicit

Member Data Documentation

inQueue

template<typename E >

ProcessingQueue<E>& osmscout::Consumer< E >::inQueue

protected

---

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

• Worker.h