Write-only stream type used during firmware upgrade. More...

#include <UpgradeOutputStream.h>

Inheritance diagram for Ota::UpgradeOutputStream:

Collaboration diagram for Ota::UpgradeOutputStream:

Public Types
using	Partition = Storage::Partition

Public Member Functions
	UpgradeOutputStream (Partition partition, size_t maxLength=0)
	Construct a stream for the given partition. More...

virtual	~UpgradeOutputStream ()

size_t	write (const uint8_t *data, size_t size) override
	Write chars to stream. More...

StreamType	getStreamType () const override
	Get the stream type. More...

uint16_t	readMemoryBlock (char *data, int bufSize) override
	Read a block of memory. More...

bool	seek (int len) override
	Move read cursor. More...

int	available () override
	Return the total length of the stream. More...

bool	isFinished () override
	Check if all data has been read. More...

virtual bool	close ()

size_t	getStartAddress () const

size_t	getMaxLength () const

Public Member Functions inherited from ReadWriteStream
size_t	write (uint8_t charToWrite) override
	From Stream class: We don't write using this stream. More...

virtual size_t	copyFrom (IDataSourceStream *source, size_t size=SIZE_MAX)
	Copy data from a source stream. More...

virtual size_t	write (uint8_t c)=0
	Writes a single character to output stream. 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...

Public Member Functions inherited from IDataSourceStream
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...

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)

Public Member Functions inherited from Stream
	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)

Public Member Functions inherited from Print
virtual	~Print ()

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...

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)

Protected Member Functions
virtual bool	init ()

Protected Member Functions inherited from Stream
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...

Protected Member Functions inherited from Print
void	setWriteError (int err=1)

Protected Attributes
OtaUpgrader	ota

Partition	partition

bool	initialized {false}

size_t	written {0}

size_t	maxLength {0}

Protected Attributes inherited from Stream
uint16_t	receiveTimeout = 1000
	number of milliseconds to wait for the next char before aborting timed read More...

Detailed Description

Write-only stream type used during firmware upgrade.

Member Typedef Documentation

◆ Partition

using Ota::UpgradeOutputStream::Partition = Storage::Partition

Constructor & Destructor Documentation

◆ UpgradeOutputStream()

Ota::UpgradeOutputStream::UpgradeOutputStream	(	Partition	partition,
		size_t	maxLength = `0`
	)

inline

Construct a stream for the given partition.

Parameters

partition

◆ ~UpgradeOutputStream()

virtual Ota::UpgradeOutputStream::~UpgradeOutputStream ( )

inlinevirtual

Member Function Documentation

◆ available()

int Ota::UpgradeOutputStream::available ( )

inlineoverridevirtual

Return the total length of the stream.

Return values

int	-1 is returned when the size cannot be determined

Reimplemented from IDataSourceStream.

◆ close()

virtual bool Ota::UpgradeOutputStream::close ( )

virtual

◆ getMaxLength()

size_t Ota::UpgradeOutputStream::getMaxLength ( ) const

inline

◆ getStartAddress()

size_t Ota::UpgradeOutputStream::getStartAddress ( ) const

inline

◆ getStreamType()

StreamType Ota::UpgradeOutputStream::getStreamType ( ) const

inlineoverridevirtual

Get the stream type.

Return values

StreamType The stream type.

Reimplemented from IDataSourceStream.

◆ init()

virtual bool Ota::UpgradeOutputStream::init ( )

protectedvirtual

◆ isFinished()

bool Ota::UpgradeOutputStream::isFinished ( )

inlineoverridevirtual

Check if all data has been read.

Return values

bool	True on success.

Implements IDataSourceStream.

◆ readMemoryBlock()

uint16_t Ota::UpgradeOutputStream::readMemoryBlock	(	char *	data,
		int	bufSize
	)

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()

bool Ota::UpgradeOutputStream::seek ( int len )

inlineoverridevirtual

Move read cursor.

Parameters

len	Relative cursor adjustment

Return values

bool	True on success.

Reimplemented from IDataSourceStream.

◆ write()

size_t Ota::UpgradeOutputStream::write	(	const uint8_t *	buffer,
		size_t	size
	)

overridevirtual

Write chars to stream.

Parameters

buffer	Pointer to buffer to write to the stream
size	Quantity of chars to write

Return values

size_t Quantity of chars written to stream

Note: Although this is defined in the Print class, ReadWriteStream uses this as the core output method so descendants are required to implement it

Implements ReadWriteStream.

Member Data Documentation

◆ initialized

bool Ota::UpgradeOutputStream::initialized {false}

protected

◆ maxLength

size_t Ota::UpgradeOutputStream::maxLength {0}

protected

◆ ota

OtaUpgrader Ota::UpgradeOutputStream::ota

protected

◆ partition

Partition Ota::UpgradeOutputStream::partition

protected

◆ written

size_t Ota::UpgradeOutputStream::written {0}

protected

The documentation for this class was generated from the following file:

UpgradeOutputStream.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Partition

Constructor & Destructor Documentation

◆ UpgradeOutputStream()

◆ ~UpgradeOutputStream()

Member Function Documentation

◆ available()

◆ close()

◆ getMaxLength()

◆ getStartAddress()

◆ getStreamType()

◆ init()

◆ isFinished()

◆ readMemoryBlock()

◆ seek()

◆ write()

Member Data Documentation

◆ initialized

◆ maxLength

◆ ota

◆ partition

◆ written