169 lines
4.8 KiB
C
169 lines
4.8 KiB
C
#ifndef __BUFFER_H__
|
|
#define __BUFFER_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
|
|
typedef struct read_buffer_t {
|
|
const char *buffer;
|
|
size_t size, index;
|
|
} read_buffer_t;
|
|
|
|
typedef struct write_buffer_t {
|
|
char *buffer;
|
|
size_t size, index;
|
|
} write_buffer_t;
|
|
|
|
/**
|
|
* Init the read buffer.
|
|
*
|
|
* The caller owns the memory pointed to by "data". The lifetime of the memory
|
|
* should persist across the lifetime of the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to initialize.
|
|
* @param[in] data The array of bytes to read from.
|
|
* @param[in] size The size of the array of bytes.
|
|
*/
|
|
|
|
void buffer_read_init(read_buffer_t *buffer, const char *data, size_t size);
|
|
|
|
/**
|
|
* Init the write buffer.
|
|
*
|
|
* @param[in] buffer The buffer to initialize.
|
|
* @param[out] data The array of bytes to write to.
|
|
* @param[in] size The size of the array of bytes.
|
|
*/
|
|
void buffer_write_init(write_buffer_t *buffer, char *data, size_t size);
|
|
|
|
/**
|
|
* Read an array of bytes from the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to read from.
|
|
* @param[out] data The read data.
|
|
* @param[in] size The size of the array of bytes.
|
|
* @return 1 if there are not enough bytes to read from the buffer, 0 otherwise.
|
|
*/
|
|
int buffer_read_buffer(read_buffer_t *buffer, char *data, size_t size);
|
|
|
|
/**
|
|
* Write an array of bytes to the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to write to.
|
|
* @param[in] data The data to write.
|
|
* @param[in] size The size of the array of bytes.
|
|
* @return 1 if there is not enough room in the buffer to write the data, 0 otherwise.
|
|
*/
|
|
int buffer_write_buffer(write_buffer_t *buffer, const char *data, size_t size);
|
|
|
|
/**
|
|
* Read an uint32_t from the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to read from.
|
|
* @param[out] data The read data.
|
|
* @return 1 if there are not enough bytes to read from the buffer, 0 otherwise.
|
|
*/
|
|
int buffer_read_uint32(read_buffer_t *buffer, uint32_t *data);
|
|
|
|
/**
|
|
* Write an uint32_t to the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to write to.
|
|
* @param[in] data The data to write.
|
|
* @return 1 if there is not enough room in the buffer to write the data, 0 otherwise.
|
|
*/
|
|
int buffer_write_uint32(write_buffer_t *buffer, uint32_t data);
|
|
|
|
/**
|
|
* Read an uint16_t from the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to read from.
|
|
* @param[out] data The read data.
|
|
* @return 1 if there are not enough bytes to read from the buffer, 0 otherwise.
|
|
*/
|
|
int buffer_read_uint16(read_buffer_t *buffer, uint16_t *data);
|
|
|
|
/**
|
|
* Write an uint16_t to the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to write to.
|
|
* @param[in] data The data to write.
|
|
* @return 1 if there is not enough room in the buffer to write the data, 0 otherwise.
|
|
*/
|
|
int buffer_write_uint16(write_buffer_t *buffer, uint16_t data);
|
|
|
|
/**
|
|
* Read an uint8_t from the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to read from.
|
|
* @param[out] data The read data.
|
|
* @return 1 if there are not enough bytes to read from the buffer, 0 otherwise.
|
|
*/
|
|
int buffer_read_uint8(read_buffer_t *buffer, uint8_t *data);
|
|
|
|
/**
|
|
* Write an uint8_t to the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to write to.
|
|
* @param[in] data The data to write.
|
|
* @return 1 if there is not enough room in the buffer to write the data, 0 otherwise.
|
|
*/
|
|
int buffer_write_uint8(write_buffer_t *buffer, uint8_t data);
|
|
|
|
/**
|
|
* Read an int32_t from the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to read from.
|
|
* @param[out] data The read data.
|
|
* @return 1 if there are not enough bytes to read from the buffer, 0 otherwise.
|
|
*/
|
|
int buffer_read_int32(read_buffer_t *buffer, int32_t *data);
|
|
|
|
/**
|
|
* Write an int32_t to the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to write to.
|
|
* @param[in] data The data to write.
|
|
* @return 1 if there is not enough room in the buffer to write the data, 0 otherwise.
|
|
*/
|
|
int buffer_write_int32(write_buffer_t *buffer, int32_t data);
|
|
|
|
/**
|
|
* Read an int16_t from the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to read from.
|
|
* @param[out] data The read data.
|
|
* @return 1 if there are not enough bytes to read from the buffer, 0 otherwise.
|
|
*/
|
|
int buffer_read_int16(read_buffer_t *buffer, int16_t *data);
|
|
|
|
/**
|
|
* Write an int16_t to the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to write to.
|
|
* @param[in] data The data to write.
|
|
* @return 1 if there is not enough room in the buffer to write the data, 0 otherwise.
|
|
*/
|
|
int buffer_write_int16(write_buffer_t *buffer, int16_t data);
|
|
|
|
/**
|
|
* Read an int8_t from the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to read from.
|
|
* @param[out] data The read data.
|
|
* @return 1 if there are not enough bytes to read from the buffer, 0 otherwise.
|
|
*/
|
|
int buffer_read_int8(read_buffer_t *buffer, int8_t *data);
|
|
|
|
/**
|
|
* Write an int8_t to the buffer.
|
|
*
|
|
* @param[in] buffer The buffer to write to.
|
|
* @param[in] data The data to write.
|
|
* @return 1 if there is not enough room in the buffer to write the data, 0 otherwise.
|
|
*/
|
|
int buffer_write_int8(write_buffer_t *buffer, int8_t data);
|
|
|
|
|
|
#endif // __BUFFER_H__
|