urcl::comm::IProducer< T > Class Template Reference

Parent class for arbitrary producers of packages. More...

#include <pipeline.h>

Inheritance diagram for urcl::comm::IProducer< T >:

Public Member Functions
virtual void	setupProducer (const size_t max_num_tries=0, const std::chrono::milliseconds reconnection_time=std::chrono::seconds(10))
	Set-up functionality of the producers. More...
virtual void	startProducer ()
virtual void	stopProducer ()
	Stops the producer. More...
virtual void	teardownProducer ()
	Fully tears down the producer - by default no difference to stopping it. More...
virtual bool	tryGet (std::vector< std::unique_ptr< T >> &products)=0
	Reads packages from some source and produces corresponding objects. More...
virtual	~IProducer ()=default

Detailed Description

template<typename T>
class urcl::comm::IProducer< T >

Parent class for arbitrary producers of packages.

Template Parameters

T	Type of the produced products

Definition at line 206 of file pipeline.h.

Constructor & Destructor Documentation

~IProducer()

template<typename T >

virtual urcl::comm::IProducer< T >::~IProducer ( )

virtualdefault

Member Function Documentation

setupProducer()

template<typename T >

virtual void urcl::comm::IProducer< T >::setupProducer ( const size_t  max_num_tries = 0, const std::chrono::milliseconds  reconnection_time = std::chrono::seconds(10)  )

inlinevirtual

Set-up functionality of the producers.

Parameters

max_num_tries	Maximum number of connection attempts before counting the connection as failed. Unlimited number of attempts when set to 0.
reconnection_time	time in between connection attempts to the server

Reimplemented in urcl::comm::URProducer< T >.

Definition at line 218 of file pipeline.h.

startProducer()

template<typename T >

virtual void urcl::comm::IProducer< T >::startProducer ( )

inlinevirtual

Reimplemented in urcl::comm::URProducer< T >.

Definition at line 236 of file pipeline.h.

stopProducer()

template<typename T >

virtual void urcl::comm::IProducer< T >::stopProducer ( )

inlinevirtual

Stops the producer.

Reimplemented in urcl::comm::URProducer< T >.

Definition at line 232 of file pipeline.h.

teardownProducer()

template<typename T >

virtual void urcl::comm::IProducer< T >::teardownProducer ( )

inlinevirtual

Fully tears down the producer - by default no difference to stopping it.

Reimplemented in urcl::comm::URProducer< T >.

Definition at line 225 of file pipeline.h.

tryGet()

template<typename T >

virtual bool urcl::comm::IProducer< T >::tryGet ( std::vector< std::unique_ptr< T >> &  products )

pure virtual

Reads packages from some source and produces corresponding objects.

Parameters

products

Vector of unique pointers to be filled with produced packages.

Returns

Success of the package production.

Implemented in urcl::comm::URProducer< T >.

---

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

• pipeline.h