ReadBufferInterface.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2020 Embedded AMS B.V. - All Rights Reserved
 *
 *  This file is part of Embedded Proto.
 *
 *  Embedded Proto is open source software: you can redistribute it and/or 
 *  modify it under the terms of the GNU General Public License as published 
 *  by the Free Software Foundation, version 3 of the license.
 *
 *  Embedded Proto  is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Embedded Proto. If not, see <https://www.gnu.org/licenses/>.
 *
 *  For commercial and closed source application please visit:
 *  <https://EmbeddedProto.com/license/>.
 *
 *  Embedded AMS B.V.
 *  Info:
 *    info at EmbeddedProto dot com
 *
 *  Postal address:
 *    Johan Huizingalaan 763a
 *    1066 VH, Amsterdam
 *    the Netherlands
 */
 
#ifndef _READ_BUFFER_INTERFACE_H_
#define _READ_BUFFER_INTERFACE_H_
 
#include <cstdint>
 
 
namespace EmbeddedProto 
{
 
  class ReadBufferInterface
  {
    public:
 
      ReadBufferInterface() = default;
      virtual ~ReadBufferInterface() = default;
 
      virtual uint32_t get_size() const = 0;
 
      virtual uint32_t get_max_size() const = 0;
 
 
      virtual bool peek(uint8_t& byte) const = 0;
 
      virtual void advance() = 0;
 
 
      virtual void advance(const uint32_t N) = 0;
 
 
      virtual bool pop(uint8_t& byte) = 0;
 
  };
 
} // End of namespace EmbeddedProto
 
#endif // End of _READ_BUFFER_INTERFACE_H_