SdFat
|
Ring buffer for data loggers. More...
#include <RingBuf.h>
Public Member Functions | |
void | begin (F *file) |
size_t | bytesFree () const |
size_t | bytesFreeIsr () const |
size_t | bytesUsed () const |
size_t | bytesUsedIsr () const |
size_t | memcpyIn (const void *buf, size_t count) |
size_t | memcpyOut (void *buf, size_t count) |
size_t | printField (double value, char term, uint8_t prec=2) |
size_t | printField (float value, char term, uint8_t prec=2) |
template<typename Type > | |
size_t | printField (Type value, char term) |
size_t | readIn (size_t count) |
RingBuf () | |
bool | sync () |
size_t | write (const char *str) |
size_t | write (const uint8_t *buf, size_t count) override |
size_t | write (const void *buf, size_t count) |
size_t | write (uint8_t data) override |
size_t | writeOut (size_t count) |
Ring buffer for data loggers.
This ring buffer may be used in ISRs. bytesFreeIsr(), bytesUsedIsr(), memcopyIn(), and memcopyOut() are ISR callable. For ISR use call memcopyIn() in the ISR and use writeOut() in non-interrupt code to write data to a file. readIn() and memcopyOut can be use in a similar way to provide file data to an ISR.
Print into a RingBuf in an ISR should also work but has not been verified.
|
inline |
Initialize RingBuf.
[in] | file | Underlying file. |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Copy data to the RingBuf from buf. The number of bytes copied may be less than count if count is greater than bytesFree.
This function may be used in an ISR with writeOut() in non-interrupt code.
[in] | buf | Location of data to be copied. |
[in] | count | number of bytes to be copied. |
|
inline |
Copy date from the RingBuf to buf. The number of bytes copied may be less than count if bytesUsed is less than count.
This function may be used in an ISR with readIn() in non-interrupt code.
[out] | buf | Location to receive the data. |
[in] | count | number of bytes to be copied. |
|
inline |
Print a number followed by a field terminator.
[in] | value | The number to be printed. |
[in] | term | The field terminator. Use '\n' for CR LF. |
[in] | prec | Number of digits after decimal point. |
|
inline |
Print a number followed by a field terminator.
[in] | value | The number to be printed. |
[in] | term | The field terminator. Use '\n' for CR LF. |
[in] | prec | Number of digits after decimal point. |
|
inline |
Print a number followed by a field terminator.
[in] | value | The number to be printed. |
[in] | term | The field terminator. Use '\n' for CR LF. |
|
inline |
Read data into the RingBuf from the underlying file. the number of bytes read may be less than count if bytesFree is less than count.
This function may be used in non-interrupt code with memcopyOut() in an ISR.
[in] | count | number of bytes to be read. |
|
inline |
Write all data in the RingBuf to the underlying file.
|
inline |
Copy str to RingBuf.
[in] | str | Location of data to be written. |
|
inlineoverride |
Override virtual function in Print for efficiency.
[in] | buf | Location of data to be written. |
[in] | count | number of bytes to be written. |
|
inline |
Copy data to the RingBuf from buf.
The number of bytes copied may be less than count if count is greater than bytesFree. Use getWriteError() to check for print errors and clearWriteError() to clear error.
[in] | buf | Location of data to be written. |
[in] | count | number of bytes to be written. |
|
inlineoverride |
Required function for Print.
[in] | data | Byte to be written. |
|
inline |
Write data to file from RingBuf buffer.
[in] | count | number of bytes to be written. |
The number of bytes written may be less than count if bytesUsed is less than count or if an error occurs.
This function may be used in non-interrupt code with memcopyIn() in an ISR.