xvr2::BufferedTextInputStream Class Reference

#include <BufferedTextInputStream.h>

Inheritance diagram for xvr2::BufferedTextInputStream:

[legend]

List of all members.

---

Detailed Description

Todo:

Document BufferedTextInputStream

Definition at line 23 of file BufferedTextInputStream.h.

Public Member Functions
	BufferedTextInputStream ()
	BufferedTextInputStream (RawInputStream &input, const String &__lterm=NL)
void	open (RawInputStream &input, const String &__lterm=NL)
	~BufferedTextInputStream ()
void	operator>> (String &s)
void	setBufferSize (UInt32 _size)
UInt32	remaining ()
	Returns the amount of remaining bytes to be read.
void	open (int __fd)
void	open (const String &fname)
virtual void	close ()
virtual UInt32	read (void *data, UInt32 size)
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.
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)
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 bool	opened ()
virtual FileSizeT	size ()=0
virtual FileSizeT	size ()
virtual FileOffsetT	tell ()=0
virtual FileOffsetT	tell ()
virtual const char *	getClassName ()
	Returns the name of the current class.
virtual std::string	toString ()
Static Public Member Functions
static void	setDefaultBufferSize (UInt32 _size)
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
UInt32	_bufsize
String	buffer
String	_lterm
bool	handles_timeouts
int	timeout_msecs
std::string	__cls_name
int	_fd
bool	_a_close
bool	_is_opened
Friends
std::ostream &	operator<< (std::ostream &stream, const Object &s)

---

Constructor & Destructor Documentation

xvr2::BufferedTextInputStream::BufferedTextInputStream

(

)

xvr2::BufferedTextInputStream::BufferedTextInputStream	(	RawInputStream &	input,
		const String &	__lterm = NL
	)

xvr2::BufferedTextInputStream::~BufferedTextInputStream

(

)

---

Member Function Documentation

void xvr2::BufferedTextInputStream::open	(	RawInputStream &	input,
		const String &	__lterm = NL
	)

void xvr2::BufferedTextInputStream::operator>>

(

String &

s

)

static void xvr2::BufferedTextInputStream::setDefaultBufferSize

(

UInt32

_size

)

[static]

void xvr2::BufferedTextInputStream::setBufferSize

(

UInt32

_size

)

UInt32 xvr2::BufferedTextInputStream::remaining

(

)

Returns the amount of remaining bytes to be read.

void xvr2::RawInputStream::open

(

int

__fd

)

[inherited]

Reimplemented in xvr2::Net::RawSocketInputStream.

void xvr2::RawInputStream::open

(

const String &

fname

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::close

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

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

Implements xvr2::ReadableStream.

Reimplemented in xvr2::Net::RawSocketInputStream.

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.

int xvr2::RawInputStream::fd

(

)

[inherited]

bool xvr2::RawInputStream::eof

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seek

(

FileOffsetT

_pos

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seekEnd

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seekBegin

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual void xvr2::RawInputStream::seekStep

(

FileOffsetT

_step

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Net::RawSocketInputStream.

virtual bool xvr2::RawInputStream::ready

(

int

timeout = 100

)

[virtual, inherited]

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]

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 bool xvr2::RawStreamInterface::opened

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

virtual FileSizeT xvr2::StreamInterface::size

(

)

[pure virtual, inherited]

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

virtual FileSizeT xvr2::RawStreamInterface::size

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::RawOutputStream, and xvr2::Net::RawSocketOutputStream.

virtual FileOffsetT xvr2::StreamInterface::tell

(

)

[pure virtual, inherited]

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

virtual FileOffsetT xvr2::RawStreamInterface::tell

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

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]

virtual std::string xvr2::Object::toString

(

)

[virtual, inherited]

Reimplemented in xvr2::Buffer, xvr2::Byte, xvr2::Exception, xvr2::Date, xvr2::Group, xvr2::String, xvr2::User, xvr2::Vector< _Tp, _Alloc >, xvr2::Text::MD5Hash, xvr2::Net::IPv4Address, xvr2::Net::OldTCPSocket, xvr2::Net::URI, xvr2::Platform::CPU, and xvr2::Vector< xvr2::PipelineFilter * >.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	stream,
		const Object &	s
	)			[friend, inherited]

---

Member Data Documentation

UInt32 xvr2::BufferedTextInputStream::_bufsize [protected]

Definition at line 25 of file BufferedTextInputStream.h.

String xvr2::BufferedTextInputStream::buffer [protected]

Definition at line 26 of file BufferedTextInputStream.h.

String xvr2::BufferedTextInputStream::_lterm [protected]

Definition at line 27 of file BufferedTextInputStream.h.

bool xvr2::ReadableStream::handles_timeouts [protected, inherited]

Definition at line 58 of file StreamInterface.h.

Referenced by xvr2::ReadableStream::ReadableStream().

int xvr2::ReadableStream::timeout_msecs [protected, inherited]

Definition at line 59 of file StreamInterface.h.

Referenced by xvr2::ReadableStream::ReadableStream(), and xvr2::ReadableStream::setTimeout().

std::string xvr2::Object::__cls_name [protected, inherited]

Definition at line 30 of file Object.h.

int xvr2::RawStreamInterface::_fd [protected, inherited]

Definition at line 21 of file RawStreamInterface.h.

bool xvr2::RawStreamInterface::_a_close [protected, inherited]

Definition at line 22 of file RawStreamInterface.h.

bool xvr2::RawStreamInterface::_is_opened [protected, inherited]

Definition at line 23 of file RawStreamInterface.h.

---

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

• /home/coredumped/X-VR2_Trunk/Core/xvr2/BufferedTextInputStream.h