Cpl::Io::LineReaderApi Class Reference

This abstract class defines a interface for a stream line reader. More...

Detailed Description

This abstract class defines a interface for a stream line reader.

A line reader allows the client to read one line at time from the stream. A line is consider a stream of ASCII character terminated by '
' a.k.a newline. The actual newline character(s) are handled by the interface and the client is not aware of the actual newline implementation.

#include <LineReaderApi.h>

Inheritance diagram for Cpl::Io::LineReaderApi:

Collaboration diagram for Cpl::Io::LineReaderApi:

Public Member Functions
virtual bool	readln (Cpl::Text::String &destString)=0
	Reads a single line from the stream.
virtual bool	available ()=0
	Returns true if there is data available to be read from the stream.
virtual void	close ()=0
	Closes the reader and the underlying input stream.
virtual	~LineReaderApi ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

~LineReaderApi()

virtual Cpl::Io::LineReaderApi::~LineReaderApi ( )

inlinevirtual

Lets the make the destructor virtual.

Member Function Documentation

available()

virtual bool Cpl::Io::LineReaderApi::available ( )

pure virtual

Returns true if there is data available to be read from the stream.

NOTE: The implementation of this method is VERY PLATFORM dependent! If your code uses it - it may not be portable to all platforms. If a platform does not/can not support this method it is guaranteed to return 'true'

Implemented in Cpl::Io::LineReader.

close()

virtual void Cpl::Io::LineReaderApi::close ( )

pure virtual

Closes the reader and the underlying input stream.

Implemented in Cpl::Io::LineReader.

readln()

virtual bool Cpl::Io::LineReaderApi::readln ( Cpl::Text::String &  destString )

pure virtual

Reads a single line from the stream.

If the line is greater than the will fit in 'destString', the line content is truncated. The next subsequent readln() reads the next line (NOT the truncated characters!). The '
' character is NOT copied into 'destString' but is replaced with '\0'. Returns true if successful, or false if End-of-Stream was encountered.

NOTE: This call will not return until a newline character is encounter!

Implemented in Cpl::Io::LineReader.

---

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

• Cpl/Io/LineReaderApi.h