IXMLReader Class Reference

The IXMLReader is used to "stream" data inside the Incredible XML Pull Parser. More...

#include <IXMLParser.h>

Inheritance diagram for IXMLReader:

Public Member Functions
	IXMLReader ()
virtual	~IXMLReader ()
virtual int	read (unsigned char *buffer, int nbyte)=0
	The read() method is used to "stream" data inside the Pull Parser. More...
virtual void	setNormalBufferSize (int nbyte)
virtual void	setSource (IXMLReader *source)
	do not use More...
virtual IXMLReader *	getSource ()
	do not use More...
virtual void	reset ()
	do not use More...

Detailed Description

The IXMLReader is used to "stream" data inside the Incredible XML Pull Parser.

Definition at line 394 of file IXMLParser.h.

Constructor & Destructor Documentation

IXMLReader::IXMLReader ( )

inline

Definition at line 396 of file IXMLParser.h.

virtual IXMLReader::~IXMLReader ( )

inlinevirtual

Definition at line 397 of file IXMLParser.h.

Member Function Documentation

virtual IXMLReader* IXMLReader::getSource ( )

inlinevirtual

do not use

Reimplemented in IPullParser::IXMLReader_FromUTF16, and IPullParser::IXMLReader_ToUTF16.

Definition at line 412 of file IXMLParser.h.

virtual int IXMLReader::read ( unsigned char *  buffer, int  nbyte  )

pure virtual

The read() method is used to "stream" data inside the Pull Parser.

The read() method must fill-in the memory buffer "buffer" with new data. At most "nbyte" bytes of data must be written inside the memory buffer.

Returns

The exact number of byte written inside the memory buffer (this must be smaller than "nbyte". If the read() function returns zero, it means that the data stream is finished. If the read() function returns -1, it means that the data stream is corrupted and we must abort.

Implemented in IPullParser::IXMLReader_PassThrough, IPullParser::IXMLReader_FromUTF16, IPullParser::IXMLReader_ToUTF16, IXMLReaderStringSZ, and IXMLReaderFile.

virtual void IXMLReader::reset ( )

inlinevirtual

do not use

Reimplemented in IPullParser::IXMLReader_FromUTF16, IPullParser::IXMLReader_ToUTF16, and IXMLReaderFile.

Definition at line 413 of file IXMLParser.h.

virtual void IXMLReader::setNormalBufferSize ( int  nbyte )

inlinevirtual

This method is called before any call to the "read()" method. It gives you an hint about the future value of the "nbyte" parameter of the "read()" method so that you can allocate internal buffers to the right size.

Reimplemented in IPullParser::IXMLReader_FromUTF16, and IPullParser::IXMLReader_ToUTF16.

Definition at line 405 of file IXMLParser.h.

virtual void IXMLReader::setSource ( IXMLReader *  source )

inlinevirtual

do not use

Reimplemented in IPullParser::IXMLReader_FromUTF16, and IPullParser::IXMLReader_ToUTF16.

Definition at line 411 of file IXMLParser.h.

---

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

• IXMLParser.h