Consumer, that allows one product to be consumed by multiple arbitrary conusmers. More...
#include <pipeline.h>
Public Member Functions | |
| bool | consume (std::shared_ptr< T > product) |
| Consumes a given product with all registered consumers. More... | |
| MultiConsumer (std::vector< IConsumer< T > *> consumers) | |
| Creates a new MultiConsumer object. More... | |
| virtual void | onTimeout () |
| Triggers timeout functionality for all registered consumers. More... | |
| virtual void | setupConsumer () |
| Sets up all registered consumers. More... | |
| virtual void | stopConsumer () |
| Stops all registered consumers. More... | |
| virtual void | teardownConsumer () |
| Tears down all registered consumers. More... | |
Private Attributes | |
| std::vector< IConsumer< T > * > | consumers_ |
Detailed Description
template<typename T>
class urcl::comm::MultiConsumer< T >
Consumer, that allows one product to be consumed by multiple arbitrary conusmers.
- Template Parameters
-
T Type of the consumed products
Definition at line 89 of file pipeline.h.
Constructor & Destructor Documentation
◆ MultiConsumer()
|
inline |
Creates a new MultiConsumer object.
- Parameters
-
consumers The list of consumers that should all consume given products
Definition at line 100 of file pipeline.h.
Member Function Documentation
◆ consume()
|
inlinevirtual |
Consumes a given product with all registered consumers.
- Parameters
-
product Shared pointer to the product to be consumed.
- Returns
- Success of the consumption.
Implements urcl::comm::IConsumer< T >.
Definition at line 152 of file pipeline.h.
◆ onTimeout()
|
inlinevirtual |
Triggers timeout functionality for all registered consumers.
Reimplemented from urcl::comm::IConsumer< T >.
Definition at line 137 of file pipeline.h.
◆ setupConsumer()
|
inlinevirtual |
Sets up all registered consumers.
Reimplemented from urcl::comm::IConsumer< T >.
Definition at line 107 of file pipeline.h.
◆ stopConsumer()
|
inlinevirtual |
Stops all registered consumers.
Reimplemented from urcl::comm::IConsumer< T >.
Definition at line 127 of file pipeline.h.
◆ teardownConsumer()
|
inlinevirtual |
Tears down all registered consumers.
Reimplemented from urcl::comm::IConsumer< T >.
Definition at line 117 of file pipeline.h.
Member Data Documentation
◆ consumers_
|
private |
Definition at line 92 of file pipeline.h.
The documentation for this class was generated from the following file: