Cpl::Io::TeeOutput Class Reference

This concrete class implements a Output stream that outputs the data to MANY (or none) output streams. More...

Detailed Description

This concrete class implements a Output stream that outputs the data to MANY (or none) output streams.

The write() methods will return false when at least of the Output stream(s) had an error. There are methods provided (firstFailed(), nextFailed()) which returns a list of all currently failed Output streams. Once a stream has been marked as failed it will not be added back to the list of "good/active" streams. The user must explicitly delete the stream and then re-add it. NOTE: There is no guaranty of order or 'atomicity' with respect to other streams when writing to multiple streams.

NOTE: The implementation is NOT thread safe. The application must provide its own locking/critical section logic if calling a TeeOutput instance from multiple threads.

#include <TeeOutput.h>

Inheritance diagram for Cpl::Io::TeeOutput:

Collaboration diagram for Cpl::Io::TeeOutput:

Public Member Functions
	TeeOutput ()
	Constructor.
	TeeOutput (Output &streamA)
	Constructor.
	TeeOutput (Output &streamA, Output &streamB)
	Constructor.
void	add (Output &stream)
	Adds a stream.
bool	remove (Output &stream)
	Removes a stream.
Output *	firstFailed ()
	Returns the first failed stream.
Output *	nextFailed (Output &currentFailedStream)
	Returns the next failed stream in the list.
Output *	removeAndGetNextFailed (Output &currentFailedStream)
	Removes the specified failed stream AND returns the next failed stream in the list.
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.

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

TeeOutput() [1/3]

Cpl::Io::TeeOutput::TeeOutput

(

)

Constructor.

Starts off with NO output streams

TeeOutput() [2/3]

Cpl::Io::TeeOutput::TeeOutput

(

Output &

streamA

)

Constructor.

Starts off with ONE output stream

TeeOutput() [3/3]

Cpl::Io::TeeOutput::TeeOutput	(	Output &	streamA,
		Output &	streamB
	)

Constructor.

Starts off with TWO output streams

Member Function Documentation

add()

void Cpl::Io::TeeOutput::add

(

Output &

stream

)

Adds a stream.

close()

void Cpl::Io::TeeOutput::close ( )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Close.

firstFailed()

Output * Cpl::Io::TeeOutput::firstFailed

(

)

Returns the first failed stream.

If no failed streams exist 0 will be returned.

flush()

void Cpl::Io::TeeOutput::flush ( )

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

isEos()

bool Cpl::Io::TeeOutput::isEos ( )

virtual

See Cpl::Io::IsEos.

Implements Cpl::Io::IsEos.

nextFailed()

Output * Cpl::Io::TeeOutput::nextFailed

(

Output &

currentFailedStream

)

Returns the next failed stream in the list.

If there are no more failed streams 0 will be returned.

remove()

bool Cpl::Io::TeeOutput::remove

(

Output &

stream

)

Removes a stream.

Returns true if the stream was actually removed (i.e. that it was in the list to start with). NOTE: If the stream exists it will be deleted regardless if it is consider good or failed.

removeAndGetNextFailed()

Output * Cpl::Io::TeeOutput::removeAndGetNextFailed

(

Output &

currentFailedStream

)

Removes the specified failed stream AND returns the next failed stream in the list.

If there are no more failed streams (or the specified stream is not 'failed') 0 will be returned. This method allows the user to remove the failed streams as he/she walks the failed list. NOTE: Do NOT call remove() while walking the failed list, remove() can invalidate the link pointers of the current failed stream object!!!

write()

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

virtual

See Cpl::Io::Output.

Implements Cpl::Io::Output.

---

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

• Cpl/Io/TeeOutput.h