cosmos::StreamAdaptor< STREAM_TYPE > Class Template Reference

Generic template base class for wrapping existing file descriptors in C++ streams. More...

#include <StreamAdaptor.hxx>

Inheritance diagram for cosmos::StreamAdaptor< STREAM_TYPE >:

Public Member Functions
virtual void	close ()
	Close the underlying file descriptor.
FileDescriptor	fileDesc ()

Protected Member Functions
	StreamAdaptor (FileDescriptor fd, std::ios_base::openmode mode)

Protected Attributes
StdioFileBuf	m_buffer

Detailed Description

template<typename STREAM_TYPE>
class cosmos::StreamAdaptor< STREAM_TYPE >

Generic template base class for wrapping existing file descriptors in C++ streams.

The standardized stream library does not offer an option to wrap an existing file descriptor in a stream object. One would need to implement a complete custom stream buffer type for this which is quite overkill.

Most standard libraries already offer some proprietary interface since they need to do the same thing anyways for the std::cout, std::cerr objects.

This is a base class for implementing a wrapper of an existing file descriptor offering an std::istream or std::ostream interface on top of it.

Definition at line 41 of file StreamAdaptor.hxx.

Constructor & Destructor Documentation

StreamAdaptor()

template<typename STREAM_TYPE >

cosmos::StreamAdaptor< STREAM_TYPE >::StreamAdaptor ( FileDescriptor fd, std::ios_base::openmode mode )

inlineprotected

Definition at line 54 of file StreamAdaptor.hxx.

                                                                   :
                        m_buffer{to_integral(fd.raw()), mode} {
                if (fd.invalid()) {
                        cosmos_throw (UsageError("Attempt to construct StreamAdaptor for invalid FD"));
                }
 
                this->rdbuf(&m_buffer);
        }

Member Function Documentation

close()

template<typename STREAM_TYPE >

virtual void cosmos::StreamAdaptor< STREAM_TYPE >::close ( )

inlinevirtual

Close the underlying file descriptor.

Reimplemented in cosmos::InputOutputStreamAdaptor, and cosmos::OutputStreamAdaptor.

Definition at line 46 of file StreamAdaptor.hxx.

                             {
                m_buffer.close();
        }

fileDesc()

template<typename STREAM_TYPE >

FileDescriptor cosmos::StreamAdaptor< STREAM_TYPE >::fileDesc ( )

inline

Definition at line 50 of file StreamAdaptor.hxx.

{ return FileDescriptor{FileNum{m_buffer.fd()}}; }

Member Data Documentation

m_buffer

template<typename STREAM_TYPE >

StdioFileBuf cosmos::StreamAdaptor< STREAM_TYPE >::m_buffer

protected

Definition at line 64 of file StreamAdaptor.hxx.

---

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

• include/io/StreamAdaptor.hxx