Consumer< T > Class Template Reference

The Consumer interface. More...

#include <consumer.h>

Inheritance diagram for Consumer< T >:

Public Member Functions
	Consumer ()
	Consumer constructor.
virtual	~Consumer ()
	Consumer destructor.
virtual void	producer (Producer< T > *const producer)
	Sets the producer from which to retrieve data.

Protected Member Functions
T	consume () const
	Returns one datum from the producer.

Private Attributes
Producer< T > *	_producer
	The Producer from which to retrieve data.

Detailed Description

template<typename T>
class Consumer< T >

The Consumer interface.

See also

Producer/Consumer.

Template Parameters

T	The data type consumed.

Definition at line 15 of file consumer.h.

Constructor & Destructor Documentation

Consumer()

template<typename T>

Consumer< T >::Consumer

(

)

Consumer constructor.

Definition at line 38 of file consumer.h.

~Consumer()

template<typename T>

virtual Consumer< T >::~Consumer ( )

inlinevirtual

Consumer destructor.

Definition at line 21 of file consumer.h.

Member Function Documentation

consume()

template<typename T>

T Consumer< T >::consume ( ) const

protected

Returns one datum from the producer.

Returns

The datum.

Definition at line 48 of file consumer.h.

producer()

template<typename T>

void Consumer< T >::producer ( Producer< T > *const producer )

virtual

Sets the producer from which to retrieve data.

Parameters

[in]

producer

The producer from which to retrieve data.

Definition at line 42 of file consumer.h.

Member Data Documentation

_producer

template<typename T>

Producer<T>* Consumer< T >::_producer

private

The Producer from which to retrieve data.

Definition at line 34 of file consumer.h.

---

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

• src/producer_consumer/consumer.h