Wiring/Stream.h

Go to the documentation of this file.

/* $Id: Stream.h 1151 2011-06-06 21:13:05Z bhagman $
||
|| @author         Brett Hagman <bhagman@wiring.org.co>
|| @url            http://wiring.org.co/
|| @contribution   Alexander Brevig <abrevig@wiring.org.co>
|| @contribution   David A. Mellis
||
|| @description
|| | Base class for streams.
|| |
|| | Wiring Common API
|| #
||
|| @notes
|| | Originally discussed here:
|| |
|| | http://code.google.com/p/arduino/issues/detail?id=60
|| #
||
|| @license Please see cores/Common/License.txt.
||
*/
 
#pragma once
 
#include "Print.h"
 
class Stream : public Print
{
public:
    virtual int available() = 0;
    virtual int peek() = 0;
    virtual int read() = 0;
    virtual void flush() = 0;
 
    Stream() = default;
 
    // parsing methods
 
    void setTimeout(unsigned long timeout)
    {
        receiveTimeout = timeout;
    }
 
    bool find(const char* target)
    {
        return findUntil(target, "");
    }
 
    bool find(const char* target, size_t length)
    {
        return findUntil(target, length, nullptr, 0);
    }
 
    bool findUntil(const char* target, const char* terminator);
 
    bool findUntil(const char* target, size_t targetLen, const char* terminate, size_t termLen);
 
    long parseInt();
 
    float parseFloat();
 
    virtual size_t readBytes(char* buffer, size_t length);
 
    size_t readBytes(uint8_t* buffer, size_t length)
    {
        return readBytes(reinterpret_cast<char*>(buffer), length);
    }
 
    size_t readBytesUntil(char terminator, char* buffer, size_t length);
 
    virtual String readString(size_t maxLen);
 
    String readStringUntil(char terminator);
 
    /*
     * @brief Returns the location of the searched character
     * @param c Character to search for
     * @retval int -1 if not found 0 or positive number otherwise
     */
    virtual int indexOf(char)
    {
        return -1;
    }
 
protected:
    int timedRead();
    int timedPeek();
 
    int peekNextDigit();
 
    long parseInt(char skipChar);
 
    float parseFloat(char skipChar);
 
    uint16_t receiveTimeout = 1000; 
};