SharedMemoryStream< T > Class Template Reference
Memory stream operating on fixed shared buffer. More...
#include <SharedMemoryStream.h>
Inheritance diagram for SharedMemoryStream< T >:
Collaboration diagram for SharedMemoryStream< T >:
Public Member Functions | |
SharedMemoryStream (std::shared_ptr< T >(buffer), size_t size) | |
Constructor for use with pre-existing buffer. More... | |
StreamType | getStreamType () const override |
Get the stream type. More... | |
int | available () override |
Return the total length of the stream. More... | |
size_t | getCapacity () const |
uint16_t | readMemoryBlock (char *data, int bufSize) override |
Read a block of memory. More... | |
bool | seek (int len) override |
Move read cursor. More... | |
bool | isFinished () override |
Check if all data has been read. More... | |
![]() | |
virtual bool | isValid () const |
Determine if the stream object contains valid data. More... | |
size_t | readBytes (char *buffer, size_t length) override |
Read chars from stream into buffer. More... | |
int | read () override |
Read one character and moves the stream pointer. More... | |
int | peek () override |
Read a character without advancing the stream pointer. More... | |
virtual int | seekFrom (int offset, SeekOrigin origin) |
Change position in stream. More... | |
size_t | write (uint8_t charToWrite) override |
From Stream class: We don't write using this stream. More... | |
void | flush () override |
virtual String | id () const |
Returns unique id of the resource. More... | |
virtual String | getName () const |
Returns name of the resource. More... | |
virtual MimeType | getMimeType () const |
Get MIME type for stream content. More... | |
String | readString (size_t maxLen) override |
Overrides Stream method for more efficient reading. More... | |
virtual bool | moveString (String &s) |
Memory-based streams may be able to move content into a String. More... | |
virtual size_t | readBytes (char *buffer, size_t length) |
Read chars from stream into buffer. More... | |
size_t | readBytes (uint8_t *buffer, size_t length) |
![]() | |
Stream () | |
void | setTimeout (unsigned long timeout) |
Set maximum milliseconds to wait for stream data, default is 1 second. More... | |
bool | find (const char *target) |
Read data from the stream until the target string is found. More... | |
bool | find (const char *target, size_t length) |
Read data from the stream until the target string of given length is found. More... | |
bool | findUntil (const char *target, const char *terminator) |
As find() but search ends if the terminator string is found. More... | |
bool | findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen) |
As findUntil(const char*, const char*) but search ends if the terminate string is found. More... | |
long | parseInt () |
Returns the first valid (long) integer value from the current position. More... | |
float | parseFloat () |
float version of parseInt More... | |
size_t | readBytes (uint8_t *buffer, size_t length) |
size_t | readBytesUntil (char terminator, char *buffer, size_t length) |
As readBytes() with terminator character. More... | |
String | readStringUntil (char terminator) |
virtual int | indexOf (char c) |
![]() | |
Print () | |
Print (const Print &)=delete | |
Print (Print &&)=delete | |
virtual | ~Print () |
Print & | operator= (const Print &)=delete |
Print & | operator= (Print &&)=delete |
int | getWriteError () |
Gets last error. More... | |
void | clearWriteError () |
Clears the last write error. More... | |
size_t | write (const char *str) |
Writes a c-string to output stream. More... | |
virtual size_t | write (const uint8_t *buffer, size_t size) |
Writes characters from a buffer to output stream. More... | |
size_t | write (const char *buffer, size_t size) |
Writes characters from a buffer to output stream. More... | |
size_t | print (char c) |
Prints a single character to output stream. More... | |
size_t | print (const char str[]) |
Prints a c-string to output stream. More... | |
size_t | print (double num, int digits=2) |
Print a floating-point number to output stream. More... | |
template<typename T > | |
std::enable_if< has_printTo< T >::value, size_t >::type | print (const T &obj) |
Prints a Printable object to output stream. More... | |
size_t | print (const String &s) |
Prints a String to output stream. More... | |
template<typename E > | |
std::enable_if< std::is_enum< E >::value &&!std::is_convertible< E, int >::value, size_t >::type | print (E value) |
enums can be printed as strings provided they have a toString(E) implementation. More... | |
size_t | println () |
Prints a newline to output stream. More... | |
template<typename... Args> | |
size_t | println (const Args &... args) |
Print value plus newline to output stream. More... | |
size_t | printf (const char *fmt,...) |
Prints a formatted c-string to output stream. More... | |
size_t | print (unsigned long num, uint8_t base=DEC) |
template<typename... Args> | |
size_t | print (unsigned long num, Args... args) |
template<typename... Args> | |
size_t | print (const unsigned long long &num, Args... args) |
size_t | print (long num, uint8_t base=DEC) |
template<typename... Args> | |
size_t | print (long num, Args... args) |
template<typename... Args> | |
size_t | print (const long long &num, Args... args) |
template<typename... Args> | |
size_t | print (unsigned int num, Args... args) |
template<typename... Args> | |
size_t | print (unsigned char num, Args... args) |
template<typename... Args> | |
size_t | print (int num, Args... args) |
Additional Inherited Members | |
![]() | |
int | timedRead () |
int | timedPeek () |
int | peekNextDigit () |
returns the next numeric digit in the stream or -1 if timeout More... | |
long | parseInt (char skipChar) |
Like regular parseInt() but the given skipChar is ignored. More... | |
float | parseFloat (char skipChar) |
Like parseInt(skipChar) for float. More... | |
![]() | |
void | setWriteError (int err=1) |
![]() | |
uint16_t | receiveTimeout = 1000 |
number of milliseconds to wait for the next char before aborting timed read More... | |
Detailed Description
template<typename T>
class SharedMemoryStream< T >
Memory stream operating on fixed shared buffer.
One reason for templating this class is for distinction between char
or const char
types, to avoid dangerous casts. Elements may be structures or other types.
Constructor & Destructor Documentation
◆ SharedMemoryStream()
template<typename T >
|
inline |
Constructor for use with pre-existing buffer.
- Parameters
-
buffer size Size of buffer in elements
Member Function Documentation
◆ available()
template<typename T >
|
inlineoverridevirtual |
Return the total length of the stream.
- Return values
-
int -1 is returned when the size cannot be determined
Reimplemented from IDataSourceStream.
◆ getCapacity()
template<typename T >
|
inline |
◆ getStreamType()
template<typename T >
|
inlineoverridevirtual |
◆ isFinished()
template<typename T >
|
inlineoverridevirtual |
◆ readMemoryBlock()
template<typename T >
|
inlineoverridevirtual |
Read a block of memory.
- Parameters
-
data Pointer to the data to be read bufSize Quantity of chars to read
- Return values
-
uint16_t Quantity of chars read
- Todo:
- Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?
Implements IDataSourceStream.
◆ seek()
template<typename T >
|
inlineoverridevirtual |
Move read cursor.
- Parameters
-
len Relative cursor adjustment
- Return values
-
bool True on success.
Reimplemented from IDataSourceStream.
The documentation for this class was generated from the following file: