buffer.h

Go to the documentation of this file.

//x comments which begin with //x are for beginner student information only
//x these comments would normally not be required

//x in every .h file it is recommended to use the following pattern:
//x 1. at the top check if a special flag is set (recommended _FILENAME_H_)
//x 2. if not define the flag
//x 3. put a matching endif at the end of the file
//x this will avoid many errors and issues if you ever include a .h file twice
//x since the second time it is included the flag _FILENAME_H_ will be defined
//x thus the contents of the file will be ignored
#ifndef _BUFFER_H_
#define _BUFFER_H_

//x include any standard headers which will be required by the module here
#include <stdint.h>
#include <stdbool.h>
//x include headers for dependent modules or any other headers required here

//x the following is a doxygen comment block. Read doxygen documentation for more
//x details
typedef struct {
    uint16_t size; 
    uint16_t max_size; 
    char *front; 
    char *rear; 
    char *buffer_start; 
    char *buffer_end; 
    void (*Callback)(void * buf); 
    //x the input to the Callback should be a buffer_t pointer; however, buffer_t
    //x has not been defined thus the pointer is cast as a void pointer.
} buffer_t;

void Push(buffer_t *buffer, char data);

char Pop(buffer_t *buffer);

uint16_t GetSize(buffer_t *buffer);

void BufferInit(buffer_t *buffer, char *data_array, uint16_t max_size);

void BufferSetCallback(buffer_t * buffer, void (*Callback)(buffer_t * buffer));

void BufferClearCallback(buffer_t * buffer);

char PushData(buffer_t * buffer, char * data, uint16_t length);

#define BUFFER_PUSH_FAILED 1 
#define BUFFER_PUSH_SUCCEEDED 0 

//x this is a special doxygen command to end a grouping of doxygen comment blocks
//x when a #endif compiler directive is not immediately after the matching #if...
//x then it is recommended to add a comment to indicate which #if it pairs with
#endif // _BUFFER_H_
//x some compilers will produce warnings if there is no blank newline at the end of a file