YModemRx::OutStream Class Reference

#include <ymodem_rx.h>

Inheritance diagram for YModemRx::OutStream:

[legend]

List of all members.

Public Member Functions
virtual int	Open (const char *fileName, size_t size)=0
virtual int	Out (const uint8_t *data, size_t size)=0
virtual	~OutStream ()

---

Detailed Description

Abstract class representing a stream of data being read.

Definition at line 51 of file ymodem_rx.h.

---

Constructor & Destructor Documentation

virtual YModemRx::OutStream::~OutStream

(

)

[virtual]

Empty destructor to avoid compiler warnings.

Definition at line 78 of file ymodem_rx.h.

---

Member Function Documentation

virtual int YModemRx::OutStream::Open	(	const char *	fileName,
		size_t	size
	)			[pure virtual]

Open the stream.

If no data has yet been written to the stream, this function may be called a second time in order to update the file size.

Parameters:

	fileName	Name for the file being received.
	size	Size of data being received.

Implemented in YModemRx::OutBlock0, and OutFile.

virtual int YModemRx::OutStream::Out	(	const uint8_t *	data,
		size_t	size
	)			[pure virtual]

Write data to the stream.

Parameters:

	data	Pointer to data to write.
	size	Size of data.

Returns:

Zero if successful, or a negative error value if failed.

Implemented in YModemRx::OutBlock0, and OutFile.

---

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

• comms/ymodem_rx.h