o2::test::Fifo< T, _BASE > Class Template Reference

A thread safe FIFO. More...

#include <Fifo.h>

Inherits std::queue< T >.

Public Types
using	value_type = T

Public Member Functions
	Fifo ()
void	push (T something, bool isLast=false)
bool	empty ()
template<typename F >
bool	pull (F processor)

Detailed Description

template<class T, class _BASE = std::queue<T>>
class o2::test::Fifo< T, _BASE >

A thread safe FIFO.

The class inherits protected, this makes all methods of the underlying container inaccessible to the outside. All methods can only be called through the implemented methods of this class which are thread protected.

TODO: not sure at the moment what is the best option to indicate end-of-data in the FIFO. Right now, the push method takes an optional parameter to indicate the last insertion. This allows for checking in the pull method whether data can be expected despite of a currently empty queue, or if the pull should be terminated immediately.

Definition at line 59 of file Fifo.h.

Member Typedef Documentation

value_type

template<class T , class _BASE = std::queue<T>>

using o2::test::Fifo< T, _BASE >::value_type = T

Definition at line 63 of file Fifo.h.

Constructor & Destructor Documentation

Fifo()

template<class T , class _BASE = std::queue<T>>

o2::test::Fifo< T, _BASE >::Fifo ( )

inline

Definition at line 62 of file Fifo.h.

Member Function Documentation

empty()

template<class T , class _BASE = std::queue<T>>

bool o2::test::Fifo< T, _BASE >::empty ( )

inline

Check if FIFO empty

TODO: make this const, but then the const'ness must be cast away in order to lock the mutex

Definition at line 83 of file Fifo.h.

pull()

template<class T , class _BASE = std::queue<T>>

template<typename F >

bool o2::test::Fifo< T, _BASE >::pull ( F  processor )

inline

Pull one value from the FIFO and process it using the provided processor function. The return value from the processor is propagated to indicate whether to continue pulling from the FIFO or not.

Definition at line 95 of file Fifo.h.

push()

template<class T , class _BASE = std::queue<T>>

void o2::test::Fifo< T, _BASE >::push ( T  something, bool  isLast = false  )

inline

Push value to the FIFO

Definition at line 68 of file Fifo.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Utilities/DataCompression/test/Fifo.h