This concrete template class implements the AtomicOutputApi using a mutex to enforce the 'atomic-ness' of the operation, i.e. More...

Detailed Description

template<class CONTEXT>
class Cpl::Io::AtomicOutput< CONTEXT >

This concrete template class implements the AtomicOutputApi using a mutex to enforce the 'atomic-ness' of the operation, i.e.

all output operations occur synchronously in the caller's thread.

The template arg - CONTEXT - is the class that implements the callback when requestOutputs() is called.

#include <AtomicOutput.h>

Inheritance diagram for Cpl::Io::AtomicOutput< CONTEXT >:

[legend]

Collaboration diagram for Cpl::Io::AtomicOutput< CONTEXT >:

[legend]

Public Member Functions
	AtomicOutput (Output &stream, Cpl::System::Mutex &lock)
	The application is responsible for supplying the actual Output stream.

bool	requestOutputs (CONTEXT &client, typename AtomicOutputApi< CONTEXT >::OutputsFunction_T clientsMethod)
	See AtomicOutputApi.

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::AtomicOutputApi< CONTEXT >
virtual bool	requestOutputs (CONTEXT &client, OutputsFunction_T clientsMethod)=0
	This method is used to output a series of output operations to the stream as a single atomic operation.

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
Output &	m_stream
	Underlying output stream.

Cpl::System::Mutex &	m_lock
	Lock to provide the 'atomic' functionality.

Additional Inherited Members
Public Types inherited from Cpl::Io::AtomicOutputApi< CONTEXT >
typedef bool(CONTEXT::*	OutputsFunction_T) (Output &)
	Definition of the call-back method that is used by the client/context to atomically publish many output operations.

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

◆ AtomicOutput()

template<class CONTEXT >

Cpl::Io::AtomicOutput< CONTEXT >::AtomicOutput	(	Output &	stream,
		Cpl::System::Mutex &	lock
	)

The application is responsible for supplying the actual Output stream.

In addition, the application must supply a 'lock'. This allows the application to associate each Output stream with it own lock or the application could chose to use a single lock for all Atomic Output streams.