This partially abstract class defines a interface for operating on an input stream (example of a stream is 'stdin' or a socket connection). More...

Detailed Description

This partially abstract class defines a interface for operating on an input stream (example of a stream is 'stdin' or a socket connection).

All Read calls on the stream are 'blocking' - i.e. the calls do not return until one or more bytes have been read from the stream.

Note: There is really only just one read() method (the one the returns 'bytesRead'). All of the other read() are convenience methods and as such a default implementation is provided for these methods.

#include <Input.h>

Inheritance diagram for Cpl::Io::Input:

[legend]

Collaboration diagram for Cpl::Io::Input:

[legend]

Public Member Functions
virtual bool	read (char &c)
	Reads a single byte from the stream.

virtual bool	read (Cpl::Text::String &destString)
	Reads N bytes into the String's internal buffer.

virtual bool	read (void *buffer, int numBytes, int &bytesRead)=0
	Attempts to read the specified number of bytes from the stream in the supplied buffer.

virtual bool	available ()=0
	Returns true if there data available to be read from the stream.

virtual	~Input ()
	Lets the make the destructor virtual.

Public Member Functions inherited from Cpl::Io::Close
virtual void	close ()=0
	This method will close the stream.

virtual	~Close ()
	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.

Public Member Functions inherited from Cpl::Io::IsEos
virtual bool	isEos ()=0
	This method returns true if End-of-Stream was encountered on the stream.

virtual	~IsEos ()
	Lets the make the destructor virtual.

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

◆ ~Input()

virtual Cpl::Io::Input::~Input ( )

inlinevirtual

Lets the make the destructor virtual.

Reimplemented in Cpl::Io::File::Input.

Member Function Documentation

◆ available()

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

pure virtual

Returns true if there 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::File::Input, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, Cpl::Io::Null, Cpl::Io::Ram::InputOutput, Cpl::Io::Serial::Adafruit::Nrf5::InputOutput, Cpl::Io::Serial::Arduino::InputOutput, Cpl::Io::Serial::PhonyStdio::InputOutput, Cpl::Io::Serial::ST::M32F4::InputOutput, Cpl::Io::Socket::InputOutput, Cpl::Io::Stdio::Input_, Cpl::Io::Stdio::InputOutput_, Cpl::Io::Tcp::InputOutput, and Cpl::Io::Serial::Adafruit::Nrf5::BLE::InputOutput.

◆ read() [1/3]

virtual bool Cpl::Io::Input::read ( char & c )

virtual

Reads a single byte from the stream.

Returns true if successful, or false if End-of-Stream was encountered.

Reimplemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, and Cpl::Io::Stdio::InputOutput_.

◆ read() [2/3]

virtual bool Cpl::Io::Input::read ( Cpl::Text::String & destString )

virtual

Reads N bytes into the String's internal buffer.

The number of bytes read will be less or equal to the String's max length. The String is guaranteed to be terminated by a '\0'. The placement of the '\0' is determined by the number of bytes read from the stream (i.e. buffer[bytesRead] = '\0'). Returns true if successful, or false if End-of-Stream was encountered.

NOTE: NO FILTERING of 'non-printable' characters is done! Therefore it is up to the client application to deal with the problem!

Reimplemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, and Cpl::Io::Stdio::InputOutput_.

◆ read() [3/3]

virtual bool Cpl::Io::Input::read	(	void *	buffer,
		int	numBytes,
		int &	bytesRead
	)

pure virtual

Attempts to read the specified number of bytes from the stream in the supplied buffer.

The actual number of bytes read is returned via 'bytesRead'. Returns true if successful, or false if End-of-Stream was encountered.

Implemented in Cpl::Io::File::Input, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, Cpl::Io::Null, Cpl::Io::Ram::InputOutput, Cpl::Io::Serial::Adafruit::Nrf5::BLE::InputOutput, Cpl::Io::Serial::Adafruit::Nrf5::InputOutput, Cpl::Io::Serial::Arduino::InputOutput, Cpl::Io::Serial::PhonyStdio::InputOutput, Cpl::Io::Serial::ST::M32F4::InputOutput, Cpl::Io::Socket::InputOutput, Cpl::Io::Stdio::Input_, Cpl::Io::Stdio::InputOutput_, and Cpl::Io::Tcp::InputOutput.

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

Cpl/Io/Input.h