---

/buffer.h

Go to the documentation of this file.

/*! \file buffer.h \brief Multipurpose byte buffer structure and methods. */
//*****************************************************************************
//
// File Name    : 'buffer.h'
// Title        : Multipurpose byte buffer structure and methods
// Author       : Pascal Stang - Copyright (C) 2001-2002
// Created      : 9/23/2001
// Revised      : 11/16/2002
// Version      : 1.1
// Target MCU   : any
// Editor Tabs  : 4
//
// This code is distributed under the GNU Public License
//      which can be found at http://www.gnu.org/licenses/gpl.txt
//
//*****************************************************************************

#ifndef BUFFER_H
#define BUFFER_H

// structure/typdefs

// the cBuffer structure
typedef struct struct_cBuffer
{
    unsigned char *dataptr;         // the physical memory address where the buffer is stored
    unsigned short size;            // the allocated size of the buffer
    unsigned short datalength;      // the length of the data currently in the buffer
    unsigned short dataindex;       // the index into the buffer where the data starts
} cBuffer;

// function prototypes

//! initialize a buffer to start at a given address and have given size
void            bufferInit(cBuffer* buffer, unsigned char *start, unsigned short size);

//! get the first byte from the front of the buffer
unsigned char   bufferGetFromFront(cBuffer* buffer);

//! dump (discard) the first numbytes from the front of the buffer
void bufferDumpFromFront(cBuffer* buffer, unsigned short numbytes);

//! get a byte at the specified index in the buffer (kind of like array access)
// ** note: this does not remove the byte that was read from the buffer
unsigned char   bufferGetAtIndex(cBuffer* buffer, unsigned short index);

//! add a byte to the end of the buffer
unsigned char   bufferAddToEnd(cBuffer* buffer, unsigned char data);

//! check if the buffer is full/not full (returns non-zero value if not full)
unsigned char   bufferIsNotFull(cBuffer* buffer);

//! flush (clear) the contents of the buffer
void            bufferFlush(cBuffer* buffer);

#endif

---