xentara::utils::io::StreamBase Class Reference

Common base class for input and output streams. More...

#include <xentara/utils/io/StreamBase.hpp>

Inheritance diagram for xentara::utils::io::StreamBase:

Public Member Functions
virtual	~StreamBase () noexcept(false)=0
	Virtual, throwing destructor.
auto	streamDescription () const -> std::string
	Get a description of the device.

Protected Member Functions
virtual auto	doGetStreamDescription () const -> std::string=0
	Called by the framework to get a description of the stream.

Detailed Description

Common base class for input and output streams.

Constructor & Destructor Documentation

~StreamBase()

virtual xentara::utils::io::StreamBase::~StreamBase ( )

pure virtual

Virtual, throwing destructor.

Member Function Documentation

doGetStreamDescription()

virtual auto xentara::utils::io::StreamBase::doGetStreamDescription ( ) const -> std::string

protectedpure virtual

Called by the framework to get a description of the stream.

Returns

Must return a description of the stream, suitable for debug outputs

Implemented in xentara::utils::ipc::NamedPipeStream< Element >, xentara::utils::network::SocketStream< Element >, xentara::utils::io::AbstractDeviceInputStream< Element >, and xentara::utils::io::AbstractDeviceOutputStream< Element >.

streamDescription()

auto xentara::utils::io::StreamBase::streamDescription

(

)

const -> std::string

Get a description of the device.

Returns

A description of the stream suitable for debug outputs