Cpl::Io::Output Class Reference

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

Detailed Description

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

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

#include <Output.h>

Inheritance diagram for Cpl::Io::Output:

Collaboration diagram for Cpl::Io::Output:

Public Member Functions
virtual bool	write (char c)
	Writes a single byte to the stream.
virtual bool	write (const char *string)
	Writes a string to the stream.
virtual bool	write (const Cpl::Text::String &string)
	Writes a string to the stream.
virtual bool	write (Cpl::Text::String &formatBuffer, const char *format,...)
	Formatted write to the stream.
virtual bool	vwrite (Cpl::Text::String &formatBuffer, const char *format, va_list ap)
	Same as write( String& formatBuffer, const char* format,...), except that it is called with a va_list instead of a variable number of arguments.
virtual bool	write (const void *buffer, int numBytes)
	Writes the content of the buffer to the stream.
virtual bool	write (const void *buffer, int maxBytes, int &bytesWritten)=0
	Writes the content of the buffer to the stream.
virtual void	flush ()=0
	Forces all buffered data (if any) to be written to the stream media.
virtual	~Output ()
	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

~Output()

virtual Cpl::Io::Output::~Output ( )

inlinevirtual

Lets the make the destructor virtual.

Reimplemented in Cpl::Io::File::Output.

Member Function Documentation

flush()

virtual void Cpl::Io::Output::flush ( )

pure virtual

Forces all buffered data (if any) to be written to the stream media.

Implemented in Cpl::Io::AtomicOutput< CONTEXT >, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, Cpl::Io::File::Output, 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::InputOutput_, Cpl::Io::Stdio::Output_, Cpl::Io::Tcp::InputOutput, and Cpl::Io::TeeOutput.

vwrite()

virtual bool Cpl::Io::Output::vwrite ( Cpl::Text::String &  formatBuffer, const char *  format, va_list  ap  )

virtual

Same as write( String& formatBuffer, const char* format,...), except that it is called with a va_list instead of a variable number of arguments.

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

write() [1/6]

virtual bool Cpl::Io::Output::write ( char  c )

virtual

Writes a single byte to the stream.

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

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

write() [2/6]

virtual bool Cpl::Io::Output::write ( const char *  string )

virtual

Writes a string to the stream.

The string's trailing '\0' is stripped off and not outputted to the stream. Returns true if successful, or false if End-of-Stream was encountered. The method does not return until all characters in the string have been written to the Output stream.

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

write() [3/6]

virtual bool Cpl::Io::Output::write ( const Cpl::Text::String &  string )

virtual

Writes a string to the stream.

The string's trailing '\0' is stripped off and not outputted to the stream. Returns true if successful, or false if End-of-Stream was encountered. The method does not return until all characters in the string have been written to the Output stream.

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

write() [4/6]

virtual bool Cpl::Io::Output::write ( const void *  buffer, int  maxBytes, int &  bytesWritten  )

pure virtual

Writes the content of the buffer to the stream.

At most 'maxBytes' will be outputted. The actual number of bytes written is returned via 'bytesWritten'. Returns true if successful, or false if End-of-Stream was encountered.

Implemented in Cpl::Io::AtomicOutput< CONTEXT >, Cpl::Io::File::InputOutput, Cpl::Io::File::Null, Cpl::Io::File::Output, 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::InputOutput_, Cpl::Io::Stdio::Output_, Cpl::Io::Tcp::InputOutput, and Cpl::Io::TeeOutput.

write() [5/6]

virtual bool Cpl::Io::Output::write ( const void *  buffer, int  numBytes  )

virtual

Writes the content of the buffer to the stream.

Returns true if successful, or false if End-of-Stream as encountered. The method does not return until 'numBytes' have been written to the Output stream.

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

write() [6/6]

virtual bool Cpl::Io::Output::write ( Cpl::Text::String &  formatBuffer, const char *  format,   ...  )

virtual

Formatted write to the stream.

The formatting syntax/semantics is the same as printf(). The string's trailing '\0' is stripped off and not outputted to the stream. The client is required to provide storage for a temporary buffer used to format the outgoing data. The contents of 'formatBuffer' will match what was written to the stream. Returns true if successful, or false if End-of-Stream was encountered. The method does not return until the all of the characters in the 'formatBuffer' (after the contents have been 'formated') is written to the Output stream.

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

---

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

• Cpl/Io/Output.h