terminalpp::stdout_channel Class Reference

A class that models the terminal's channel concept, providing output to stdout. More...

#include <stdout_channel.hpp>

Public Member Functions
void	async_read (std::function< void(terminalpp::bytes)> const &)
	Request data from the channel.
void	write (terminalpp::bytes data)
	Writes the data to stdout.
bool	is_alive () const
	Returns whether the output stream is alive.
void	close ()
	Requests that the channel be closed.

Detailed Description

A class that models the terminal's channel concept, providing output to stdout.

Member Function Documentation

async_read()

void terminalpp::stdout_channel::async_read

(

std::function< void(terminalpp::bytes)> const &

)

Request data from the channel.

A stdout channel does no inputting, so this is silently discarded.

close()

void terminalpp::stdout_channel::close

(

)

Requests that the channel be closed.

For simplicity, a stdout channel cannot be closed, so this is a no-op.

is_alive()

bool terminalpp::stdout_channel::is_alive

(

)

const

Returns whether the output stream is alive.

For simplicity, a stdout channel is always alive.

---

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

• /home/runner/work/terminalpp/terminalpp/include/terminalpp/stdout_channel.hpp
• /home/runner/work/terminalpp/terminalpp/src/stdout_channel.cpp