Cpl::Io::Stdio::Output_ Class Reference

This concrete class implements a Output stream using the underlying platform's native OS 'file interface' for the C library's stdin, stdout, and stderr streams. More...

Detailed Description

This concrete class implements a Output stream using the underlying platform's native OS 'file interface' for the C library's stdin, stdout, and stderr streams.

This class is intended to be a helper class and/or implementation inheritance parent class than an class used directly by the Application.

#include <Output_.h>

Inheritance diagram for Cpl::Io::Stdio::Output_:

Collaboration diagram for Cpl::Io::Stdio::Output_:

Public Member Functions
	Output_ (int fd)
	Constructor.
	Output_ (void *handle)
	Constructor.
	Output_ (Cpl::Io::Descriptor streamfd)
	Constructor.
	Output_ (void)
	Constructor.
	~Output_ (void)
	Destructor.
void	activate (int fd)
	Activates and/or resets the underlying 'fd' for the stream.
void	activate (void *handle)
	Activates and/or resets the underlying 'handle' for the stream.
void	activate (Cpl::Io::Descriptor streamfd)
	Activates and/or resets the underlying 'streamfd' for the stream.
bool	isOpened ()
	This method returns true if the file was successfully open and/or is still opened (i.e.
bool	write (const void *buffer, int maxBytes, int &bytesWritten)
	See Cpl::Io::Output.
void	flush ()
	See Cpl::Io::Output.
bool	isEos ()
	See Cpl::Io::IsEos.
void	close ()
	See Cpl::Io::Output.
Public Member Functions inherited from Cpl::Io::Output
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	~Output ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::Close
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	~IsEos ()
	Lets the make the destructor virtual.

Protected Attributes
Cpl::Io::Descriptor	m_outFd
	Stream Handle.
bool	m_outEos
	Cache end-of-stream status.

Friends
class	InputOutput_
class	Cpl::Io::File::Output
class	Cpl::Io::File::InputOutput

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_() [1/4]

Cpl::Io::Stdio::Output_::Output_

(

int

fd

)

Constructor.

'fd' is a the 'file/stream descriptor' of a existing/opened stream.

Output_() [2/4]

Cpl::Io::Stdio::Output_::Output_

(

void *

handle

)

Constructor.

'handle' is a the 'file/stream descriptor' of a existing/opened stream.

Output_() [3/4]

Cpl::Io::Stdio::Output_::Output_

(

Cpl::Io::Descriptor

streamfd

)

Constructor.

'streamfd' is a the 'file/stream descriptor' of a existing/opened stream.

Output_() [4/4]

Cpl::Io::Stdio::Output_::Output_

(

void

)

Constructor.

No underlying file descriptor - the stream must be activated before using

~Output_()

Cpl::Io::Stdio::Output_::~Output_

(

void

)

Destructor.

Member Function Documentation

activate() [1/3]

void Cpl::Io::Stdio::Output_::activate

(

Cpl::Io::Descriptor

streamfd

)

Activates and/or resets the underlying 'streamfd' for the stream.

If the current 'fd' is not in the closed state - a fatal error is generated

activate() [2/3]

void Cpl::Io::Stdio::Output_::activate

(

int

fd

)

Activates and/or resets the underlying 'fd' for the stream.

If the current 'fd' is not in the closed state - a fatal error is generated

activate() [3/3]

void Cpl::Io::Stdio::Output_::activate

(

void *

handle

)

Activates and/or resets the underlying 'handle' for the stream.

If the current 'fd' is not in the closed state - a fatal error is generated

close()

void Cpl::Io::Stdio::Output_::close ( )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Close.

Reimplemented in Cpl::Io::Stdio::StdErr, and Cpl::Io::Stdio::StdOut.

flush()

void Cpl::Io::Stdio::Output_::flush ( )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

isEos()

bool Cpl::Io::Stdio::Output_::isEos ( )

virtual

See Cpl::Io::IsEos.

Implements Cpl::Io::IsEos.

isOpened()

bool Cpl::Io::Stdio::Output_::isOpened

(

)

This method returns true if the file was successfully open and/or is still opened (i.e.

close() has not been called). Note: it is okay to call other methods in the class if the file is not open - i.e. nothing 'bad' will happen and the method will return 'failed' status (when appropriate).

write()

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

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

Member Data Documentation

m_outEos

bool Cpl::Io::Stdio::Output_::m_outEos

protected

Cache end-of-stream status.

m_outFd

Cpl::Io::Descriptor Cpl::Io::Stdio::Output_::m_outFd

protected

Stream Handle.

---

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

• Cpl/Io/Stdio/Output_.h