RingBuffer.hpp

/*
 * Copyright (C) 2022 CERN
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 *
 * Created on: 2022-04-07
 *     Author: Michal Mysior <mmysior> <michal.mysior@cern.ch>
 *
 */
 
#ifndef RING_BUFFER_HPP__
#define RING_BUFFER_HPP__
 
#include <cstdint>
#include <vector>
 
namespace smc {
namespace internal {
class RingBuffer
{
public:
    explicit RingBuffer(std::size_t size);
 
    std::size_t write(const char *data, std::size_t sz);
 
    std::size_t read(char *data, std::size_t sz);
 
    std::size_t bytesFree() const;
 
    inline std::size_t size() const { return m_buff.size(); };
 
protected:
    std::vector<char> m_buff;
    std::size_t m_ridx, m_widx;
    bool m_full;
};
 
} // namespace internal
} // namespace smc
 
#endif /* RING_BUFFER_HPP__ */