Cpl::Io::Close Class Reference

This abstract class defines a close operation that is intended to be used Input and Output streams/files. More...

Detailed Description

This abstract class defines a close operation that is intended to be used Input and Output streams/files.

Since InputOutput streams/files are supported we end up with 2 close() method when the InputOutput class inherits from Input and Output interfaces. This causes basically a 'diamond' problem. By making the close() it owns interface and a parent class - we can use the 'virtual mechanism' in C++ to ensure that for InputOutput classes there is one and only one close() method.

#include <Close.h>

Inheritance diagram for Cpl::Io::Close:

Collaboration diagram for Cpl::Io::Close:

Public Member Functions
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.

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

~Close()

virtual Cpl::Io::Close::~Close ( )

inlinevirtual

Lets the make the destructor virtual.

Member Function Documentation

close()

virtual void Cpl::Io::Close::close ( )

pure virtual

This method will close the stream.

The result of closing the stream is dependent on the actual concrete stream/platform.

Implemented in Cpl::Io::AtomicOutput< CONTEXT >, Cpl::Io::File::Input, 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::Input_, Cpl::Io::Stdio::InputOutput_, Cpl::Io::Stdio::Output_, Cpl::Io::Stdio::StdErr, Cpl::Io::Stdio::StdIn, Cpl::Io::Stdio::StdOut, Cpl::Io::Tcp::InputOutput, and Cpl::Io::TeeOutput.

---

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

• Cpl/Io/Close.h