frameQueue.hpp

Go to the documentation of this file.

 
#ifndef CCF_COMMON_FRAME_QUEUE_HPP_H_
#define CCF_COMMON_FRAME_QUEUE_HPP_H_
 
#include <ifw/ccf/common/base.hpp>
#include <ifw/ccf/common/dataFrame.hpp>
 
 
namespace ifw::ccf::common {

  class FrameQueue: public Base {
  public:

    FrameQueue(const std::string& name,
               const uint16_t nb_of_buffers);
 
    ~FrameQueue();

    void Reset();

    const std::string& GetName() const;

    void GetFreeFrame(const uint16_t consumers,
                      DataFrame** frame);

    void GetFrame(uint16_t frame_number,
                  DataFrame** frame);

    uint16_t GetNbOfBuffers() const;

    uint16_t GetNbOfFreeBuffers();
 
  protected:
 
  private:
    void Allocate(const uint16_t buffers);
 
    std::string            m_name;
    std::vector<DataFrame> m_frames;
    uint16_t               m_frame_index;
 
    std::recursive_mutex   m_q_mtx;
  };
 
}
 
#endif // CCF_COMMON_FRAME_QUEUE_HPP_H_