ExtraFdCircBuffer.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#include <iosys.h>
#include <nbrtos.h>
#include <iointernal.h>
 
#ifndef _EXTRAFD_CIRC_BUFFER_H
#define _EXTRAFD_CIRC_BUFFER_H
 
// A circular buffer object, referred to as a "cbo"
struct CircularBufferObject
{
    OS_CRIT criticalSection;   // Critical section to make it task safe
 
    uint32_t readIndex;    // Buffer index of next char to get
    uint32_t writeIndex;   // Buffer index of next char to put
 
    uint32_t dataBufferSize;   // Size of data buffer
    char *dataBuffer;          // Data storage space
 
    bool enableOverwrite;     // Continuously overwrite buffer instead of setting full flag
    char overwriteTermByte;   // When in overwrite mode and buffer is full, bytes will be
                              //   flushed up to the terminator instead of one at a time.
                              //   Useful for lines/strings terminated with \r\n
};
 
// int CircularBufferInit(CircularBufferObject *pCbo, char *pBuffer, uint32_t bufferSize);
int CircularBufferInit(CircularBufferObject *pCbo, char *pBuffer, uint32_t bufferSize, bool enableOverwrite, uint8_t overwriteTermByte);
int CircularBufferRead(int fd, char *buf, int nbytes);
int CircularBufferWrite(int fd, char *buf, int nbytes);
void CircularBufferRawPrint(int fdCircBuffer, int fdDestination);
 
#endif