Async  1.4.0
Public Member Functions | List of all members
Async::PtyStreamBuf Class Reference

A stream buffer class to stream characters to a PTY. More...

#include <AsyncPtyStreamBuf.h>

Inheritance diagram for Async::PtyStreamBuf:

Public Member Functions

 PtyStreamBuf (Pty *pty, std::size_t buf_size=256)
 Default constructor. More...
 
 ~PtyStreamBuf (void)
 Destructor. More...
 
Ptypty (void) const
 A_brief_member_function_description. More...
 

Detailed Description

A stream buffer class to stream characters to a PTY.

Author
Tobias Blomberg / SM0SVX
Date
2014-12-20

This class can be used to write data to a UNIX 98 PTY using the standard streaming interface. The typical usage pattern is to first create an instance of a Pty. Then an instance of this class is created, the stream buffer. Lastly a std::ostream can be created with the stream buffer as an argument to the constructor. The std::ostream can then be used as any other output stream.

Definition at line 124 of file AsyncPtyStreamBuf.h.

Constructor & Destructor Documentation

Async::PtyStreamBuf::PtyStreamBuf ( Pty pty,
std::size_t  buf_size = 256 
)
explicit

Default constructor.

Parameters
ptyA previously created PTY object

Referenced by pty().

Async::PtyStreamBuf::~PtyStreamBuf ( void  )

Destructor.

Member Function Documentation

Pty* Async::PtyStreamBuf::pty ( void  ) const
inline

A_brief_member_function_description.

Parameters
param1Description_of_param1
Returns
Return_value_of_this_member_function

Definition at line 143 of file AsyncPtyStreamBuf.h.

References PtyStreamBuf().


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