bytebuffer.hpp

#ifndef QOS_BYTE_BUFFER
#define QOS_BYTE_BUFFER
 
#include "include/types.hpp"
 
 
namespace qOS {
 
    class byteBuffer {
        private:
            volatile byte_t *buffer{ nullptr };
            volatile index_t tail{ 0U };
            volatile index_t head{ 0U };
            size_t length{ 0U };
            static size_t checkValidPowerOfTwo( size_t k ) noexcept;
            byteBuffer( byteBuffer const& ) = delete;
            void operator=( byteBuffer const& ) = delete;
        public:
            virtual ~byteBuffer() {}
            byteBuffer( volatile byte_t *pBuffer, const size_t bLength )
            {
                (void)setup( pBuffer, bLength );
            }
            template <size_t numberOfBytes>
            byteBuffer( volatile byte_t (&area)[numberOfBytes] ) noexcept
            {
                (void)setup( area, numberOfBytes );
            }
            bool setup( volatile byte_t *pBuffer, const size_t bLength ) noexcept;
            template <size_t numberOfBytes>
            bool setup( volatile byte_t (&area)[numberOfBytes] ) noexcept // skipcq : CXX-W2066
            {
                return setup( area, numberOfBytes );
            }
            bool put( const byte_t bData ) noexcept;
            bool read( void *dst, const size_t n ) noexcept;
            bool get( byte_t *dst ) noexcept;
            byte_t peek( void ) const noexcept;
            bool isEmpty( void ) const noexcept;
            bool isFull( void ) const noexcept;
            size_t count( void ) const noexcept;
    };
 
}
 
 
#endif /*QOS_BYTE_BUFFER*/