buffer.h

Go to the documentation of this file.

//*****************************************************************************
//
// 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_HPP
#define BUFFER_HPP

// structure/typdefs

typedef struct struct_cBuffer
{
    unsigned char *dataptr; 
    unsigned short size; 
    unsigned short datalength; 
    unsigned short dataindex; 
} cBuffer;

// function prototypes

void bufferInit(cBuffer *buffer, unsigned char *start, unsigned short size);

unsigned char bufferGetFromFront(cBuffer *buffer);

void bufferDumpFromFront(cBuffer *buffer, unsigned short numbytes);

// ** note: this does not remove the byte that was read from the buffer
unsigned char bufferGetAtIndex(cBuffer *buffer, unsigned short index);

unsigned char bufferAddToEnd(cBuffer *buffer, unsigned char data);

unsigned char bufferIsNotFull(cBuffer *buffer);

void bufferFlush(cBuffer *buffer);

#endif