Programming (Threading in C++)

#ifndef FIFO_HPP #define FIFO_HPP #include <list> #include <mutex> #include <condition_variable> /** * @class Fifo * * The purpose of this class is to create a templatized * software fifo that has blocking read/pop functionality * * Arbitrary objects can be placed in the FIFO in a thread safe * manner. They can also be removed in a thread safe way, and if * the fifo is empty, the pop will block until it has something to return * * The Fifo should function in a "by value" way. I.E. when items are added, * they are copied into the fifo. When they are popped, the item that is * popped is used to populate the passed in by ref object */ template<class T> class Fifo { public: /** * @brief Add Item to fifo * * @param item Object to be copied into FIFO */ void addItem(const T &item); /** * @brief Pop item from fifo * * @param item Object to be populated with the value * of the object being removed from the fifo */ void popItem(T &item); private: /** @brief Used to track/contain FIFO contents */ std::list<T> m_items; /** @brief Needed to protect list and for use by m_cv */ std::mutex m_mtx; /** @brief Used to manage sleeping until FIFO not emtpy */ std::condition_variable m_cv; }; #endif /* FIFO_HPP */