Parent class for for arbitrary consumers. More...
#include <pipeline.h>
Public Member Functions | |
| virtual bool | consume (std::shared_ptr< T > product)=0 |
| Consumes a product, utilizing it's contents. More... | |
| virtual void | onTimeout () |
| Functionality for handling consumer timeouts. More... | |
| virtual void | setupConsumer () |
| Set-up functionality of the consumer. More... | |
| virtual void | stopConsumer () |
| Stops the consumer. More... | |
| virtual void | teardownConsumer () |
| Fully tears down the consumer - by default no difference to stopping it. More... | |
Detailed Description
template<typename T>
class urcl::comm::IConsumer< T >
Parent class for for arbitrary consumers.
- Template Parameters
-
T Type of the consumed products
Definition at line 42 of file pipeline.h.
Member Function Documentation
|
pure virtual |
Consumes a product, utilizing it's contents.
- Parameters
-
product Shared pointer to the product to be consumed.
- Returns
- Success of the consumption.
Implemented in urcl::comm::MultiConsumer< T >, urcl::CalibrationChecker, and urcl::comm::ShellConsumer< T >.
|
inlinevirtual |
Functionality for handling consumer timeouts.
Reimplemented in urcl::comm::MultiConsumer< T >, and urcl::CalibrationChecker.
Definition at line 67 of file pipeline.h.
|
inlinevirtual |
Set-up functionality of the consumer.
Reimplemented in urcl::comm::MultiConsumer< T >, and urcl::CalibrationChecker.
Definition at line 48 of file pipeline.h.
|
inlinevirtual |
Stops the consumer.
Reimplemented in urcl::comm::MultiConsumer< T >, and urcl::CalibrationChecker.
Definition at line 61 of file pipeline.h.
|
inlinevirtual |
Fully tears down the consumer - by default no difference to stopping it.
Reimplemented in urcl::comm::MultiConsumer< T >, and urcl::CalibrationChecker.
Definition at line 54 of file pipeline.h.
The documentation for this class was generated from the following file: