FIXME_docs. More...

#include <Rw11VirtStream.hpp>

Inheritance diagram for Retro::Rw11VirtStream:

Collaboration diagram for Retro::Rw11VirtStream:

Public Types
enum	stats { kStatNVSRead = Rw11Virt::kDimStat , kStatNVSReadByt , kStatNVSWrite , kStatNVSWriteByt , kStatNVSFlush , kStatNVSTell , kStatNVSSeek , kDimStat }

Public Types inherited from Retro::Rw11Virt
enum	stats { kDimStat = 0 }

Public Member Functions
	Rw11VirtStream (Rw11Unit *punit)
	Default constructor.

	~Rw11VirtStream ()
	Destructor.

virtual bool	Open (const std::string &url, RerrMsg &emsg)
	FIXME_docs.

int	Read (uint8_t *data, size_t count, RerrMsg &emsg)
	FIXME_docs.

bool	Write (const uint8_t *data, size_t count, RerrMsg &emsg)
	FIXME_docs.

bool	Flush (RerrMsg &emsg)
	FIXME_docs.

int	Tell (RerrMsg &emsg)
	FIXME_docs.

bool	Seek (int pos, RerrMsg &emsg)
	FIXME_docs.

bool	Error () const
	FIXME_docs.

bool	Eof () const
	FIXME_docs.

virtual void	Dump (std::ostream &os, int ind=0, const char *text=0, int detail=0) const
	FIXME_docs.

Public Member Functions inherited from Retro::Rw11Virt
	Rw11Virt (Rw11Unit *punit)
	Default constructor.

virtual	~Rw11Virt ()
	Destructor.

	Rw11Virt (const Rw11Virt &)=delete

Rw11Virt &	operator= (const Rw11Virt &)=delete

Rw11Unit &	Unit () const
	FIXME_docs.

Rw11Cntl &	Cntl () const
	FIXME_docs.

Rw11Cpu &	Cpu () const
	FIXME_docs.

Rw11 &	W11 () const
	FIXME_docs.

RlinkServer &	Server () const
	FIXME_docs.

RlogFile &	LogFile () const
	FIXME_docs.

virtual bool	WProt () const
	FIXME_docs.

const RparseUrl &	Url () const
	FIXME_docs.

virtual bool	Open (const std::string &url, RerrMsg &emsg)=0

Rstats &	Stats ()
	FIXME_docs.

virtual void	Dump (std::ostream &os, int ind=0, const char *text=0, int detail=0) const
	FIXME_docs.

Static Public Member Functions
static std::unique_ptr< Rw11VirtStream >	New (const std::string &url, Rw11Unit *punit, RerrMsg &emsg)
	FIXME_docs.

Protected Attributes
bool	fIStream
	is input (read only) stream

bool	fOStream
	is output (write only) stream

FILE *	fFile
	file ptr

Protected Attributes inherited from Retro::Rw11Virt
Rw11Unit *	fpUnit
	back ref to unit

RparseUrl	fUrl

bool	fWProt
	write protected

Rstats	fStats
	statistics

Detailed Description

FIXME_docs.

Definition at line 29 of file Rw11VirtStream.hpp.

Member Enumeration Documentation

◆ stats

enum Retro::Rw11VirtStream::stats

Enumerator
kStatNVSRead
kStatNVSReadByt
kStatNVSWrite
kStatNVSWriteByt
kStatNVSFlush
kStatNVSTell
kStatNVSSeek
kDimStat

Definition at line 52 of file Rw11VirtStream.hpp.

Constructor & Destructor Documentation

◆ Rw11VirtStream()

Retro::Rw11VirtStream::Rw11VirtStream ( Rw11Unit * punit )

explicit

Default constructor.

Definition at line 43 of file Rw11VirtStream.cpp.

References Retro::Rstats::Define(), Retro::Rw11Virt::fStats, kStatNVSFlush, kStatNVSRead, kStatNVSReadByt, kStatNVSSeek, kStatNVSTell, kStatNVSWrite, and kStatNVSWriteByt.

◆ ~Rw11VirtStream()

Retro::Rw11VirtStream::~Rw11VirtStream ( )

Destructor.

Definition at line 61 of file Rw11VirtStream.cpp.

References fFile.

Member Function Documentation

◆ Open()

bool Retro::Rw11VirtStream::Open	(	const std::string &	url,
		RerrMsg &	emsg
	)

virtual

FIXME_docs.

Implements Retro::Rw11Virt.

Definition at line 69 of file Rw11VirtStream.cpp.

References Retro::Rw11Unit::AttachOpts(), Retro::Rtools::CreateBackupFile(), fFile, Retro::RparseUrl::FindOpt(), fIStream, fOStream, Retro::Rw11Virt::fpUnit, Retro::Rw11Virt::fUrl, Retro::Rw11Virt::fWProt, Retro::RerrMsg::InitErrno(), Retro::RparseUrl::Path(), and Retro::RparseUrl::Set().

◆ Read()

int Retro::Rw11VirtStream::Read	(	uint8_t *	data,
		size_t	count,
		RerrMsg &	emsg
	)

FIXME_docs.

Definition at line 104 of file Rw11VirtStream.cpp.

References fFile, fIStream, Retro::Rw11Virt::fStats, Retro::Rstats::Inc(), Retro::RerrMsg::InitErrno(), kStatNVSRead, and kStatNVSReadByt.

Referenced by Retro::Rw11UnitStream::VirtRead().

◆ Write()

bool Retro::Rw11VirtStream::Write	(	const uint8_t *	data,
		size_t	count,
		RerrMsg &	emsg
	)

FIXME_docs.

Definition at line 126 of file Rw11VirtStream.cpp.

References fFile, fOStream, Retro::Rw11Virt::fStats, Retro::Rstats::Inc(), Retro::RerrMsg::InitErrno(), kStatNVSWrite, and kStatNVSWriteByt.

Referenced by Retro::Rw11UnitStream::VirtWrite().

◆ Flush()

bool Retro::Rw11VirtStream::Flush ( RerrMsg & emsg )

FIXME_docs.

Definition at line 148 of file Rw11VirtStream.cpp.

References fFile, fOStream, Retro::Rw11Virt::fStats, Retro::Rstats::Inc(), Retro::RerrMsg::InitErrno(), and kStatNVSFlush.

Referenced by Retro::Rw11UnitStream::VirtFlush().

◆ Tell()

int Retro::Rw11VirtStream::Tell ( RerrMsg & emsg )

FIXME_docs.

Definition at line 167 of file Rw11VirtStream.cpp.

References fFile, Retro::Rw11Virt::fStats, Retro::Rstats::Inc(), Retro::RerrMsg::InitErrno(), and kStatNVSTell.

Referenced by Retro::Rw11UnitStream::Pos().

◆ Seek()

bool Retro::Rw11VirtStream::Seek	(	int	pos,
		RerrMsg &	emsg
	)

FIXME_docs.

Definition at line 185 of file Rw11VirtStream.cpp.

References fFile, Retro::Rw11Virt::fStats, Retro::Rstats::Inc(), Retro::RerrMsg::InitErrno(), and kStatNVSSeek.

◆ Error()

bool Retro::Rw11VirtStream::Error ( ) const

FIXME_docs.

Definition at line 209 of file Rw11VirtStream.cpp.

References fFile.

Referenced by Retro::Rw11CntlLP11::UnitSetup(), and Retro::Rw11CntlPC11::UnitSetup().

◆ Eof()

bool Retro::Rw11VirtStream::Eof ( ) const

FIXME_docs.

Definition at line 217 of file Rw11VirtStream.cpp.

References fFile.

Referenced by Retro::Rw11CntlPC11::UnitSetup().

◆ Dump()

void Retro::Rw11VirtStream::Dump	(	std::ostream &	os,
		int	ind = `0`,
		const char *	text = `0`,
		int	detail = `0`
	)		const

virtual

FIXME_docs.

Reimplemented from Retro::Rw11Virt.

Definition at line 225 of file Rw11VirtStream.cpp.

References Retro::Rw11Virt::Dump(), fFile, fIStream, fOStream, and Retro::RosPrintf().

◆ New()

std::unique_ptr< Rw11VirtStream > Retro::Rw11VirtStream::New	(	const std::string &	url,
		Rw11Unit *	punit,
		RerrMsg &	emsg
	)

static

FIXME_docs.

Definition at line 247 of file Rw11VirtStream.cpp.

Member Data Documentation

◆ fIStream

bool Retro::Rw11VirtStream::fIStream

protected

is input (read only) stream

Definition at line 64 of file Rw11VirtStream.hpp.

Referenced by Dump(), Open(), and Read().

◆ fOStream

bool Retro::Rw11VirtStream::fOStream

protected

is output (write only) stream

Definition at line 65 of file Rw11VirtStream.hpp.

Referenced by Dump(), Flush(), Open(), and Write().

◆ fFile

FILE* Retro::Rw11VirtStream::fFile

protected

file ptr

Definition at line 66 of file Rw11VirtStream.hpp.

Referenced by Dump(), Eof(), Error(), Flush(), Open(), Read(), Seek(), Tell(), Write(), and ~Rw11VirtStream().

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

librw11/Rw11VirtStream.hpp
librw11/Rw11VirtStream.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ stats

Constructor & Destructor Documentation

◆ Rw11VirtStream()

◆ ~Rw11VirtStream()

Member Function Documentation

◆ Open()

◆ Read()

◆ Write()

◆ Flush()

◆ Tell()

◆ Seek()

◆ Error()

◆ Eof()

◆ Dump()

◆ New()

Member Data Documentation

◆ fIStream

◆ fOStream

◆ fFile