xvr2::RawInputStream Class Reference

#include <RawInputStream.h>

Inheritance diagram for xvr2::RawInputStream:

Detailed Description

Todo:: Document RawInputStream class

Definition at line 24 of file RawInputStream.h.


Public Member Functions
	RawInputStream ()
virtual	~RawInputStream ()
	RawInputStream (int __fd)
	RawInputStream (const String &fname)
void	open (int __fd)
void	open (const String &fname)
virtual void	close ()
virtual UInt32	read (void *data, UInt32 size)
int	fd ()
bool	eof ()
virtual void	seek (FileOffsetT _pos)
virtual void	seekEnd ()
virtual void	seekBegin ()
virtual void	seekStep (FileOffsetT _step)
virtual bool	ready (int timeout=100)
virtual ReadableStream &	operator>> (UInt32 n)
virtual ReadableStream &	operator>> (double n)
virtual ReadableStream &	operator>> (UInt64 n)
UInt32	read (UInt32 n)
UInt32	read (double n)
UInt32	read (UInt64 n)
virtual UInt32	read (Buffer &data, UInt32 size)
virtual ReadableStream &	read (Buffer &b)
	Reads all data starting from the current position to the end of the file and returns it in a Buffer object.
virtual ReadableStream &	readAll (Buffer &b)
	Loads the full contents and returns it in a Buffer.
virtual void	flush ()
virtual void	setTimeout (int millisecs)
virtual bool	opened ()=0
virtual FileSizeT	size ()=0
virtual FileOffsetT	tell ()=0
virtual const char *	getClassName ()
	Returns the name of the current class.
virtual std::string	toString ()
virtual FileSizeT	size ()
virtual FileOffsetT	tell ()
virtual bool	opened ()
Static Public Member Functions
static void	debugmsg (Object obj, const char msg, int linenumber=__LINE__, const char *srcfile=__FILE__)
	Will print a debug message to the screen.
static void	debugmsgln (Object obj, const char msg, int linenumber=__LINE__, const char *srcfile=__FILE__)
Protected Attributes
bool	handles_timeouts
int	timeout_msecs
std::string	__cls_name
int	_fd
bool	_a_close
bool	_is_opened
Private Attributes
bool	reached_eof
Friends
std::ostream &	operator<< (std::ostream &stream, const Object &s)

Constructor & Destructor Documentation

xvr2::RawInputStream::RawInputStream ( )

virtual xvr2::RawInputStream::~RawInputStream ( ) [virtual]

xvr2::RawInputStream::RawInputStream ( int __fd )

xvr2::RawInputStream::RawInputStream ( const String & fname )

Member Function Documentation

void xvr2::RawInputStream::open ( int __fd )

Reimplemented in xvr2::Net::RawSocketInputStream.

void xvr2::RawInputStream::open ( const String & fname ) [virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::close ( ) [virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual UInt32 xvr2::RawInputStream::read	(	void *	data,
		UInt32	size
	)			`[virtual]`

Implements xvr2::ReadableStream.

Reimplemented in xvr2::Net::RawSocketInputStream.

int xvr2::RawInputStream::fd ( )

bool xvr2::RawInputStream::eof ( ) [virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seek ( FileOffsetT _pos ) [virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seekEnd ( ) [virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seekBegin ( ) [virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seekStep ( FileOffsetT _step ) [virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual bool xvr2::RawInputStream::ready ( int timeout = 100 ) [virtual]

Implements xvr2::RawStreamInterface.

virtual ReadableStream& xvr2::ReadableStream::operator>> ( UInt32 n ) [virtual, inherited]

virtual ReadableStream& xvr2::ReadableStream::operator>> ( double n ) [virtual, inherited]

virtual ReadableStream& xvr2::ReadableStream::operator>> ( UInt64 n ) [virtual, inherited]

UInt32 xvr2::ReadableStream::read ( UInt32 n ) [inherited]

UInt32 xvr2::ReadableStream::read ( double n ) [inherited]

UInt32 xvr2::ReadableStream::read ( UInt64 n ) [inherited]

virtual UInt32 xvr2::ReadableStream::read	(	Buffer &	data,
		UInt32	size
	)			`[virtual, inherited]`

Reimplemented in xvr2::StdioInputFile.

virtual ReadableStream& xvr2::ReadableStream::read ( Buffer & b ) [virtual, inherited]

Reads all data starting from the current position to the end of the file and returns it in a Buffer object.

Reimplemented in xvr2::StdioInputFile.

virtual ReadableStream& xvr2::ReadableStream::readAll ( Buffer & b ) [virtual, inherited]

Loads the full contents and returns it in a Buffer.

Reimplemented in xvr2::StdioInputFile.

virtual void xvr2::ReadableStream::flush ( ) [virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioInputFile.

virtual void xvr2::ReadableStream::setTimeout ( int millisecs ) [inline, virtual, inherited]

Definition at line 79 of file StreamInterface.h.

References xvr2::ReadableStream::timeout_msecs.

virtual bool xvr2::StreamInterface::opened ( ) [pure virtual, inherited]

Implemented in xvr2::RawStreamInterface, xvr2::StdioInputFile, and xvr2::StdioOutputFile.

virtual FileSizeT xvr2::StreamInterface::size ( ) [pure virtual, inherited]

Implemented in xvr2::RawOutputStream, xvr2::RawStreamInterface, xvr2::StdioInterface, and xvr2::Net::RawSocketOutputStream.

virtual FileOffsetT xvr2::StreamInterface::tell ( ) [pure virtual, inherited]

Implemented in xvr2::RawStreamInterface, and xvr2::StdioInterface.

virtual const char* xvr2::Object::getClassName ( ) [virtual, inherited]

Returns the name of the current class.

static void xvr2::Object::debugmsg	(	Object *	obj,
		const char *	msg,
		int	linenumber = `__LINE__`,
		const char *	srcfile = `__FILE__`
	)			`[static, inherited]`

Will print a debug message to the screen.

static void xvr2::Object::debugmsgln	(	Object *	obj,
		const char *	msg,
		int	linenumber = `__LINE__`,
		const char *	srcfile = `__FILE__`
	)			`[static, inherited]`