144 lines
2.7 KiB
C++
144 lines
2.7 KiB
C++
/**
|
|
* InBuffer.h
|
|
*
|
|
* The InBuffer class is a wrapper around a data buffer and that adds
|
|
* some safety checks so that the rest of the library can safely read
|
|
* from it.
|
|
*
|
|
* This is a class that is used internally by the AMQP library. As a user
|
|
* of this library, you normally do not have to instantiate it. However,
|
|
* if you do want to store or safe messages yourself, it sometimes can
|
|
* be useful to implement it.
|
|
*
|
|
* @copyright 2014 - 2020 Copernica BV
|
|
*/
|
|
|
|
/**
|
|
* Include guard
|
|
*/
|
|
#pragma once
|
|
|
|
/**
|
|
* Dependencies
|
|
*/
|
|
#include <cstdint>
|
|
|
|
/**
|
|
* Set up namespace
|
|
*/
|
|
namespace AMQP {
|
|
|
|
/**
|
|
* Forward declarations
|
|
*/
|
|
class Buffer;
|
|
|
|
/**
|
|
* Class definition
|
|
*/
|
|
class InBuffer
|
|
{
|
|
protected:
|
|
/**
|
|
* The buffer we are reading from
|
|
* @var Buffer
|
|
*/
|
|
const Buffer &_buffer;
|
|
|
|
/**
|
|
* Number of bytes already processed
|
|
* @var uint32_t
|
|
*/
|
|
uint32_t _skip = 0;
|
|
|
|
public:
|
|
/**
|
|
* Constructor
|
|
* @param buffer Binary buffer
|
|
*/
|
|
InBuffer(const Buffer &buffer) : _buffer(buffer) {}
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~InBuffer() {}
|
|
|
|
/**
|
|
* Read the next uint8_t from the buffer
|
|
* @return uint8_t value read
|
|
*/
|
|
uint8_t nextUint8();
|
|
|
|
/**
|
|
* Read the next int8_t from the buffer
|
|
* @return int8_t value read
|
|
*/
|
|
int8_t nextInt8();
|
|
|
|
/**
|
|
* Read the next uint16_t from the buffer
|
|
* @return uint16_t value read
|
|
*/
|
|
uint16_t nextUint16();
|
|
|
|
/**
|
|
* Read the next int16_t from the buffer
|
|
* @return int16_t value read
|
|
*/
|
|
int16_t nextInt16();
|
|
|
|
/**
|
|
* Read the next uint32_t from the buffer
|
|
* @return uint32_t value read
|
|
*/
|
|
uint32_t nextUint32();
|
|
|
|
/**
|
|
* Read the next int32_t from the buffer
|
|
* @return int32_t value read
|
|
*/
|
|
int32_t nextInt32();
|
|
|
|
/**
|
|
* Read the next uint64_t from the buffer
|
|
* @return uint64_t value read
|
|
*/
|
|
uint64_t nextUint64();
|
|
|
|
/**
|
|
* Read the next int64_t from the buffer
|
|
* @return int64_t value read
|
|
*/
|
|
int64_t nextInt64();
|
|
|
|
/**
|
|
* Read a float from the buffer
|
|
* @return float float read from buffer.
|
|
*/
|
|
float nextFloat();
|
|
|
|
/**
|
|
* Read a double from the buffer
|
|
* @return double double read from buffer
|
|
*/
|
|
double nextDouble();
|
|
|
|
/**
|
|
* Get a pointer to the next binary buffer of a certain size
|
|
* @param size
|
|
* @return char*
|
|
*/
|
|
const char *nextData(uint32_t size);
|
|
|
|
/**
|
|
* The checker may access private data
|
|
*/
|
|
friend class BufferCheck;
|
|
|
|
};
|
|
|
|
/**
|
|
* End of namespace
|
|
*/
|
|
}
|