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.
	~PtyStreamBuf (void)
	Destructor.
Pty *	pty (void) const
	Return the PTY this stream is attached to.

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.

#include <sigc++/bind.h>
#include <string>
#include <cstdlib>
#include <ostream>
#include <iostream>
#include <AsyncCppApplication.h>
#include <AsyncPty.h>
#include <AsyncPtyStreamBuf.h>
#include <AsyncTimer.h>
 
using namespace std;
 
 
void write_to_stream(ostream *os)
{
  *os << "Hello, PTY\n";
}
 
 
void data_received(const void *buf, size_t len)
{
  cout << "Received: ";
  cout.write(static_cast<const char *>(buf), len);
}
 
 
int main(void)
{
  Async::CppApplication app;
 
  string pty_slave_path("/tmp/testpty");
  Async::Pty pty(pty_slave_path);
  if (!pty.open())
  {
    cout << "Failed to open PTY " << pty_slave_path << endl;
    exit(1);
  }
  pty.dataReceived.connect(sigc::ptr_fun(&data_received));
 
  Async::PtyStreamBuf psb(&pty);
  ostream os(&psb);
 
    // Flush the stream buffer after every write
  os.setf(ios::unitbuf);
 
  cout << "\nThis demo app will write a line of text every second to a PTY.\n";
  cout << "To see the printouts, in another console do:\n";
  cout << "\n\tcat /tmp/testpty\n\n";
  cout << "Or to also echo back the received text to the PTY:\n";
  cout << "\n\ttee /tmp/testpty </tmp/testpty\n\n";
 
    // Start a timer that periodically calls function write_to_stream
  Async::Timer t(1000, Async::Timer::TYPE_PERIODIC);
  sigc::slot<void, ostream*> timer_handler = sigc::ptr_fun(&write_to_stream);
  t.expired.connect(sigc::hide(sigc::bind(timer_handler, &os)));
 
  app.exec();
}
 

Examples

AsyncPtyStreamBuf_demo.cpp.

Definition at line 124 of file AsyncPtyStreamBuf.h.

Constructor & Destructor Documentation

PtyStreamBuf()

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

explicit

Default constructor.

Parameters

pty	A previously created PTY object
buf_size	The buffer size

~PtyStreamBuf()

Async::PtyStreamBuf::~PtyStreamBuf

(

void

)

Destructor.

Member Function Documentation

pty()

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

inline

Return the PTY this stream is attached to.

Returns

The PTY

Definition at line 143 of file AsyncPtyStreamBuf.h.

---

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

• AsyncPtyStreamBuf.h