osmscout::Pipe< E1, E2 > Class Template Reference

A specialisation of worker. More...

#include <Worker.h>

Inheritance diagram for osmscout::Pipe< E1, E2 >:

Public Member Functions
	Pipe (ProcessingQueue< E1 > &inQueue, ProcessingQueue< E2 > &outQueue)
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< E1 > &	inQueue
ProcessingQueue< E2 > &	outQueue

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 E1, typename E2>
class osmscout::Pipe< E1, E2 >

A specialisation of worker.

A pipe consumes events from a incoming queue and produces new events for a outgoing queue.

The incoming queue is processes until it is stopped and empty.

Template Parameters

E1	The event type of the incoming queue
E2	The event type of the outgoing queue

Constructor & Destructor Documentation

Pipe()

template<typename E1 , typename E2 >

osmscout::Pipe< E1, E2 >::Pipe ( ProcessingQueue< E1 > &  inQueue, ProcessingQueue< E2 > &  outQueue  )

inline

Member Data Documentation

inQueue

template<typename E1 , typename E2 >

ProcessingQueue<E1>& osmscout::Pipe< E1, E2 >::inQueue

protected

outQueue

template<typename E1 , typename E2 >

ProcessingQueue<E2>& osmscout::Pipe< E1, E2 >::outQueue

protected

---

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

• Worker.h