ZStreamR_Source Class Reference

A read stream providing an endless repeating sequence of bytes. More...

#include <ZStreamR_Source.h>

Inheritance diagram for ZStreamR_Source:

List of all members.

Public Member Functions
	ZStreamR_Source ()
	A sequence of zeroes.
	ZStreamR_Source (uint8 iData)
	A sequence of bytes, each with the value iData.
	ZStreamR_Source (const void *iData, size_t iDataSize)
	An arbitrary sequence of length iDataSize.
virtual void	Imp_CopyToDispatch (const ZStreamW &iStreamW, uint64 iCount, uint64 *oCountRead, uint64 *oCountWritten)
	Invoke iStreamW's Imp_CopyFrom method.
virtual void	Imp_CopyTo (const ZStreamW &iStreamW, uint64 iCount, uint64 *oCountRead, uint64 *oCountWritten)
	Actually copy data from this stream to iStreamW.
virtual void	Imp_Skip (uint64 iCount, uint64 *oCountSkipped)
	Read and discard iCount bytes.

---

Detailed Description

A read stream providing an endless repeating sequence of bytes.

ZStreamR_Source provides an endless repeating sequence of bytes. The sequence is defined by calling the appropriate constructor.

---

Member Function Documentation

void ZStreamR_Source::Imp_CopyToDispatch	(	const ZStreamW &	iStreamW,
		uint64	iCount,
		uint64 *	oCountRead,
		uint64 *	oCountWritten
	)			[virtual]

Invoke iStreamW's Imp_CopyFrom method.

The first part of the two-stage dispatch initiated by ZStreamR::CopyTo and ZStreamR::CopyAllTo. Override this method if your stream's data is in memory and thus can be written to iStreamW by a single call to its Write method.

Reimplemented from ZStreamR.

void ZStreamR_Source::Imp_CopyTo	(	const ZStreamW &	iStreamW,
		uint64	iCount,
		uint64 *	oCountRead,
		uint64 *	oCountWritten
	)			[virtual]

Actually copy data from this stream to iStreamW.

The second part of the two-stage dispatch initiated by ZStreamW::CopyFrom and ZStreamW::CopyAllFrom. The default implementation calls sCopyReadToWrite. Override this method if your stream's data is in memory and thus can be written to iStreamW by a single call to its Write method.

See also:

sCopyReadToWrite

Reimplemented from ZStreamR.

void ZStreamR_Source::Imp_Skip	(	uint64	iCount,
		uint64 *	oCountSkipped
	)			[virtual]

Read and discard iCount bytes.

Override this method if your stream implementation can skip past bytes in the stream without actually reading them.

Parameters:

	iCount	Count of bytes to be skipped.
	oCountSkipped	Number of bytes that were actually skipped. If iCount is non zero and oCountSkipped is set to zero then this indicates that the stream has reached its end.

Reimplemented from ZStreamR.

---

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

• src/stream/ZStreamR_Source.h
• src/stream/ZStreamR_Source.cpp

---