Phoenard
MemoryStream.h
Go to the documentation of this file.
1 /*
2 The MIT License (MIT)
3 
4 This file is part of the Phoenard Arduino library
5 Copyright (c) 2014 Phoenard
6 
7 Permission is hereby granted, free of charge, to any person obtaining a copy
8 of this software and associated documentation files (the "Software"), to deal
9 in the Software without restriction, including without limitation the rights
10 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 copies of the Software, and to permit persons to whom the Software is
12 furnished to do so, subject to the following conditions:
13 
14 The above copyright notice and this permission notice shall be included in
15 all copies or substantial portions of the Software.
16 
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 THE SOFTWARE.
24 */
25 
31 #include <Arduino.h>
32 
33 #ifndef _MEMORY_STREAM_H_
34 #define _MEMORY_STREAM_H_
35 
39 class MemoryStream : public Stream {
40  private:
41  const uint8_t* _data;
42  uint16_t _length;
43  uint16_t _pos;
44  public:
46  MemoryStream(const void* data, uint16_t length);
47  virtual int read();
48  virtual int peek();
49  virtual int available();
50  virtual void flush();
51  void seek(uint16_t position);
53  void reset(void);
55  size_t write(uint8_t val);
56 };
57 
58 #endif
MemoryStream(const void *data, uint16_t length)
Creates a new MemoryStream starting at the address in RAM specified.
Definition: MemoryStream.cpp:28
Stream class implementation for reading RAM memory.
Definition: MemoryStream.h:39
size_t write(uint8_t val)
Writing is as of now not supported.
Definition: MemoryStream.cpp:62
void reset(void)
Resets the stream to the beginning.
Definition: MemoryStream.cpp:58