YModemRx::OutBlock0 Class Reference

Inheritance diagram for YModemRx::OutBlock0:

[legend]

List of all members.

Public Member Functions
	OutBlock0 ()
int	Open (const char *fileName, size_t size)
int	Out (const uint8_t *data, size_t size)
int	Parse (const char *&fileName, size_t &fileSize)
Private Attributes
uint8_t	Buffer [1024]
	Copy of the data received via Out. Size of data is Size.
size_t	Size
	Size of data in Buffer.

---

Detailed Description

OutStream object for receiving block zero of Y-Modem protocol.

Definition at line 119 of file ymodem_rx.h.

---

Constructor & Destructor Documentation

YModemRx::OutBlock0::OutBlock0

(

)

Construct with no data.

Definition at line 242 of file ymodem_rx.cpp.

---

Member Function Documentation

int YModemRx::OutBlock0::Open	(	const char *	fileName,
		size_t	size
	)			[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.

Implements YModemRx::OutStream.

Definition at line 247 of file ymodem_rx.cpp.

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

Receive data for block zero.

Parameters:

	data	Pointer to data.
	size	Size of data.

Returns:

Zero.

Implements YModemRx::OutStream.

Definition at line 261 of file ymodem_rx.cpp.

int YModemRx::OutBlock0::Parse	(	const char *&	fileName,
		size_t &	fileSize
	)

Parse received data.

Parameters:

[out]	fileName	Name of file.
[out]	fileSize	Size of file being received.

Returns:

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

Definition at line 277 of file ymodem_rx.cpp.

---

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

• comms/ymodem_rx.h
• comms/ymodem_rx.cpp