thooge/esp32-nmea2000-obp60
1
0
Fork 0
mirror of https://github.com/thooge/esp32-nmea2000-obp60.git synced 2025-12-13 05:53:06 +01:00
Code Releases Activity

restructure buffer handling, better buffer logging

Browse Source
This commit is contained in:
wellenvogel
2021-12-02 17:10:50 +01:00
parent 9dcb98bb51
commit cd1fefad52
5 changed files with 115 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
lib/queue/GwBuffer.cpp
View File

@@ -2,25 +2,26 @@
void GwBuffer::lp(const char *fkt, int p)
{
LOG_DEBUG(GwLog::DEBUG+2 , "Buffer[%s]: buf=%p,wp=%d,rp=%d,used=%d,free=%d, p=%d",
fkt, buffer, offset(writePointer), offset(readPointer), usedSpace(), freeSpace(), p);
LOG_DEBUG(GwLog::DEBUG+2 , "Buffer[%s:%s]: buf=%p,wp=%d,rp=%d,used=%d,free=%d, p=%d",
name.c_str(),fkt, buffer, offset(writePointer), offset(readPointer), usedSpace(), freeSpace(), p);
}
GwBuffer::GwBuffer(GwLog *logger,size_t bufferSize)
GwBuffer::GwBuffer(GwLog *logger,size_t bufferSize,String name)
{
LOG_DEBUG(GwLog::DEBUG,"creating new buffer %p of size %d",this,(int)bufferSize);
LOG_DEBUG(GwLog::DEBUG,"creating new buffer %p=%s of size %d",this,name.c_str(),(int)bufferSize);
this->logger = logger;
this->bufferSize=bufferSize;
this->buffer=new uint8_t[bufferSize];
writePointer = buffer;
readPointer = buffer;
this->name=name;
}
GwBuffer::~GwBuffer(){
delete buffer;
}
void GwBuffer::reset(String reason)
{
LOG_DEBUG(GwLog::LOG,"reseting buffer %p, reason %s",this,reason.c_str());
LOG_DEBUG(GwLog::LOG,"reseting buffer %s, reason %s",this->name.c_str(),reason.c_str());
writePointer = buffer;
readPointer = buffer;
lp("reset");
@@ -44,7 +45,7 @@ int GwBuffer::read(){
readPointer++;
if (offset(readPointer) >= bufferSize)
readPointer -= bufferSize;
lp("read");
lp("read",rt);
return rt;
}
int GwBuffer::peek(){
@@ -56,8 +57,10 @@ size_t GwBuffer::addData(const uint8_t *data, size_t len, bool addPartial)
lp("addDataE", len);
if (len == 0)
return 0;
if (freeSpace() < len && !addPartial)
if (freeSpace() < len && !addPartial){
lp("addDataR0",0);
return 0;
}
size_t written = 0;
for (int i=0;i<2;i++){
size_t currentFree=freeSpace();
@@ -77,85 +80,41 @@ size_t GwBuffer::addData(const uint8_t *data, size_t len, bool addPartial)
}
lp("addData1", toWrite);
}
lp("addData2", written);
lp("addDataR", written);
return written;
}
/**
* write some data to the buffer writer
* return an error if the buffer writer returned < 0
*/
GwBuffer::WriteStatus GwBuffer::fetchData(GwBufferWriter *writer, int maxLen,bool errorIf0 )
{
lp("fetchDataE",maxLen);
size_t len = usedSpace();
if (maxLen > 0 && len > maxLen) len=maxLen;
if (len == 0){
lp("fetchData0",maxLen);
writer->done();
return OK;
}
size_t written = 0;
for (int i=0;i<2;i++){
size_t currentUsed=usedSpace();
size_t toWrite=len-written;
if (toWrite > currentUsed) toWrite=currentUsed;
if (toWrite > (bufferSize - offset(readPointer))) {
toWrite=bufferSize - offset(readPointer);
}
lp("fetchData1", toWrite);
if (toWrite > 0)
{
int rt = writer->write(readPointer, toWrite);
lp("fetchData2", rt);
if (rt < 0)
{
LOG_DEBUG(GwLog::DEBUG + 1, "buffer: write returns error %d", rt);
writer->done();
return ERROR;
}
if (rt > toWrite)
{
LOG_DEBUG(GwLog::DEBUG + 1, "buffer: write too many bytes(1) %d", rt);
writer->done();
return ERROR;
}
readPointer += rt;
if (offset(readPointer) >= bufferSize)
readPointer -= bufferSize;
written += rt;
if (rt == 0) break; //no need to try again
}
}
writer->done();
if (written == 0){
return (errorIf0 ? ERROR : AGAIN);
}
return (written == len)?OK:AGAIN;
}
size_t GwBuffer::fetchData(int maxLen, GwBufferHandleFunction handler, void *param){
if (usedSpace() < 1) return 0;
lp("fetchE",maxLen);
if (usedSpace() < 1) {
lp("fetchR0",0);
return 0;
}
size_t len=0;
if (writePointer > readPointer){
len=writePointer-readPointer;
}
else{
len=bufferSize-offset(readPointer)-1;
len=bufferSize-offset(readPointer);
}
if (maxLen >= 0 && maxLen < len) len=maxLen;
size_t handled=handler(readPointer,len,param);
if (handled > len) handled=len;
readPointer+=handled;
if (offset(readPointer) >= bufferSize ) readPointer-=bufferSize;
lp("fetchR",handled);
return handled;
}
size_t GwBuffer::fillData(int maxLen, GwBufferHandleFunction handler, void *param)
{
lp("fillDataE",maxLen);
if (freeSpace() < 1)
return 0;
size_t len = 0;
if (writePointer > readPointer)
if (writePointer >= readPointer)
{
len = bufferSize - offset(writePointer) - 1;
len = bufferSize - offset(writePointer);
if (len > 0 && offset(readPointer) == 0) len--;
}
else
{
@@ -163,12 +122,14 @@ size_t GwBuffer::fillData(int maxLen, GwBufferHandleFunction handler, void *para
}
if (maxLen >= 0 && maxLen < len)
len = maxLen;
if (len == 0) return 0;
size_t handled = handler(writePointer, len,param);
if (handled > len)
handled = len;
writePointer += handled;
if (offset(writePointer) >= bufferSize)
writePointer -= bufferSize;
lp("fillDataR",handled);
return handled;
}
@@ -184,22 +145,10 @@ int GwBuffer::findChar(char x){
}
of++;
}
lp("findChar2");
lp("findChar2",-1);
return -1;
}
GwBuffer::WriteStatus GwBuffer::fetchMessage(GwBufferWriter *writer,char delimiter,bool emptyIfFull){
int pos=findChar(delimiter);
if (pos < 0) {
if (!freeSpace() && emptyIfFull){
LOG_DEBUG(GwLog::LOG,"line to long, reset, buffer=%p",buffer);
reset();
return ERROR;
}
return AGAIN;
}
return fetchData(writer,pos+1,true);
}
size_t GwMessageFetcher::fetchMessageToBuffer(GwBuffer *gwbuffer,uint8_t *buffer, size_t bufferLen,char delimiter){
int offset=gwbuffer->findChar(delimiter);
@@ -228,5 +177,6 @@ size_t GwMessageFetcher::fetchMessageToBuffer(GwBuffer *gwbuffer,uint8_t *buffer
}
fetched+=rd;
}
buffer[fetched]=0;
return fetched;
}

16
lib/queue/GwBuffer.h
View File

@@ -5,13 +5,6 @@
#include "GwLog.h"
class GwBuffer;
class GwBufferWriter{
public:
int id=0; //can be set be users
virtual int write(const uint8_t *buffer,size_t len)=0;
virtual void done(){}
virtual ~GwBufferWriter(){};
};
class GwMessageFetcher{
public:
@@ -44,9 +37,10 @@ class GwBuffer{
return (size_t)(ptr-buffer);
}
GwLog *logger;
String name;
void lp(const char *fkt,int p=0);
public:
GwBuffer(GwLog *logger,size_t bufferSize);
GwBuffer(GwLog *logger,size_t bufferSize,String name);
~GwBuffer();
void reset(String reason="");
size_t freeSpace();
@@ -56,16 +50,10 @@ class GwBuffer{
int read();
int peek();
size_t fetchData(int maxLen,GwBufferHandleFunction handler, void *param);
/**
* write some data to the buffer writer
* return an error if the buffer writer returned < 0
*/
WriteStatus fetchData(GwBufferWriter *writer, int maxLen=-1,bool errorIf0 = true);
/**
* find the first occurance of x in the buffer, -1 if not found
*/
int findChar(char x);
WriteStatus fetchMessage(GwBufferWriter *writer,char delimiter,bool emptyIfFull=true);
};
#endif