Buffer::PopResult< T > Struct Template Reference

Result when calling Buffer::pop() More...

#include <pipeline.h>

Data Fields
T	value
	Actual popped result. More...
bool	valid
	Indicates validity of the result. More...

Detailed Description

template<typename T>
struct Buffer::PopResult< T >

Result when calling Buffer::pop()

The structure has a field to indicate the validity of the result. It is possible for the buffer to return a result when the owning pipeline is shut down. In this situation the result could be invalid as the call to pop() may be blocking until data is available. In this situation a valid flag of false means the value field should not be used. A valid flag of true means the value is useable from the buffer's perspective.

Template Parameters

T	Type of elements on the buffer

Field Documentation

valid

template<typename T >

bool Buffer::PopResult< T >::valid

Indicates validity of the result.

value

template<typename T >

T Buffer::PopResult< T >::value

Actual popped result.

---

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

• pipeline.h