SafeStringStream.h

Go to the documentation of this file.

#ifndef SAFE_STRING_STREAM_H
#define SAFE_STRING_STREAM_H
/*
  SafeStringStream.h  a Stream wrapper for a SafeString
  by Matthew Ford
  (c)2020 Forward Computing and Control Pty. Ltd.
  This code is not warranted to be fit for any purpose. You may only use it at your own risk.
  This code may be freely used for both private and commercial use.
  Provide this copyright is maintained.
**/
#ifdef __cplusplus
#include <Arduino.h>
#include "SafeString.h"
 
// handle namespace arduino
#include "SafeStringNameSpaceStart.h"
 
 
class SafeStringStream : public Stream {
  public:
 
    explicit SafeStringStream(); // nothing to send yet
 
    explicit SafeStringStream(SafeString &sf);
 
    // Use this constructor to set an rxBuffer to use insted of the internal 8 byte buffer
    // the sf set here can be replaced in the begin( ) call
 
    explicit SafeStringStream(SafeString &sf, SafeString &sfRxBuffer);
    
    
 
    void begin(const uint32_t baudRate = 0); // start to release at this baud rate, 0 means infinite baudRate //uint32_t 
 
    void begin(SafeString &sf, const uint32_t baudRate = 0); // start to release sf contents at this baud rate, 0 means infinite baudRate
    // this begin replaces any previous sf with the sf passed here.
    
 
    size_t write(uint8_t b);
 
    int available();
 
    int read();
 
    int peek();
 
    void flush(); // for ESP32 etc
 
    int availableForWrite();
    
    // number of chars dropped due to SafeStringStream Rx buffer overflow
    // count is reset to zero at the end of this call 
 
    size_t RxBufferOverflow();    
 
  private:
    SafeStringStream(const SafeStringStream& other);
    void init();
    unsigned long us_perByte; // == 1000000 / (baudRate/10) == 10000000 / baudRate
    uint32_t baudRate;
    unsigned long releaseNextByte();
    unsigned long sendTimerStart;
    char Rx_BUFFER[9]; // 8char + null
    SafeString* sfRxBufferPtr;
    size_t missedCharsCount;
  protected:
     SafeString *sfPtr;
};
 
#include "SafeStringNameSpaceEnd.h"
 
#endif  // __cplusplus
#endif  // SAFE_STRING_STREAM_H