TTY handle. More...

#include "handle-stream.hpp"

Inheritance diagram for uv::tty:

Public Types
using	uv_t = ::uv_tty_t

Public Types inherited from uv::stream
using	uv_t = ::uv_stream_t

using	on_connection_t = std::function< void(stream _server) >
	The function type of the callback called when a stream server has received an incoming connection. More...

Public Types inherited from uv::io
using	uv_t = void

using	on_read_t = std::function< void(io _handle, ssize_t _nread, buffer _buffer, int64_t _offset, void *_info) >
	The function type of the callback called by `read_start()` when data was read from an I/O endpoint. More...

Public Types inherited from uv::handle
using	uv_t = ::uv_handle_t

using	on_destroy_t = std::function< void(void *_data) >
	The function type of the callback called when the handle has been closed and about to be destroyed. More...

Public Member Functions
	tty (const tty &)=default

tty &	operator= (const tty &)=default

	tty (tty &&) noexcept=default

tty &	operator= (tty &&) noexcept=default

	tty (uv::loop &_loop, ::uv_file _fd, bool _readable, bool _set_blocking)
	Create a tty object from the given TTY file descriptor. More...

int	set_mode (::uv_tty_mode_t _mode) noexcept
	Set the TTY using the specified terminal mode. More...

int	get_winsize (int &_width, int &_height) const noexcept
	Get the current window size. More...

	operator const uv_t * () const noexcept

	operator uv_t * () noexcept

Public Member Functions inherited from uv::stream
	stream (const stream &)=default

stream &	operator= (const stream &)=default

	stream (stream &&) noexcept=default

stream &	operator= (stream &&) noexcept=default

on_connection_t &	on_connection () const noexcept

int	listen (int _backlog, const on_connection_t &_connection_cb) const
	Start listening for incoming connections. More...

stream	accept () const
	Accept incoming connections. More...

std::size_t	write_queue_size () const noexcept
	The amount of queued bytes waiting to be sent.

bool	is_readable () const noexcept
	Check if the stream is readable.

bool	is_writable () const noexcept
	Check if the stream is writable.

int	set_blocking (bool _enable) noexcept
	Enable or disable blocking mode for the stream. More...

	operator const uv_t * () const noexcept

	operator uv_t * () noexcept

Public Member Functions inherited from uv::io
	io (const io &)=default

io &	operator= (const io &)=default

	io (io &&) noexcept=default

io &	operator= (io &&) noexcept=default

std::size_t	write_queue_size () const noexcept
	The amount of queued bytes waiting to be written/sent to the I/O endpoint. More...

on_buffer_alloc_t &	on_alloc () const noexcept
	Set the input buffer allocation callback.

on_read_t &	on_read () const noexcept
	Set the read callback function.

int	read_start (std::size_t _size=0, int64_t _offset=-1) const
	Start reading incoming data from the I/O endpoint. More...

int	read_start (const on_buffer_alloc_t &_alloc_cb, const on_read_t &_read_cb, std::size_t _size=0, int64_t _offset=-1) const
	Start reading incoming data from the I/O endpoint with provided input buffer allocation callback (`_alloc_cb`) and read callback function (`_read_cb`). More...

int	read_stop () const
	Stop reading data from the I/O endpoint. More...

int	read_pause (bool _trigger_condition) const
	Pause reading data from the I/O endpoint. More...

int	read_resume (bool _trigger_condition)
	Resume reading data from the I/O endpoint after having been paused. More...

	operator const uv_t * () const noexcept

	operator uv_t * () noexcept

Public Member Functions inherited from uv::handle
	handle (const handle &_that)

handle &	operator= (const handle &_that)

	handle (handle &&_that) noexcept

handle &	operator= (handle &&_that) noexcept

void	swap (handle &_that) noexcept

std::uintptr_t	id () const noexcept
	The unique ID of the instance managed by this handle variable or 0 if the handle is void.

long	nrefs () const noexcept
	The current number of existing references to the same object as this handle variable refers to.

int	uv_status () const noexcept
	The status value returned by the last executed libuv API function on this handle.

on_destroy_t &	on_destroy () const noexcept

::uv_handle_type	type () const noexcept
	The tag indicating the libuv type of the handle.

const char *	type_name () const noexcept
	A string containing the name of the handle type.

uv::loop	loop () const noexcept
	The libuv loop where the handle is running on. More...

void *&	data () const noexcept
	The pointer to the user-defined arbitrary data. libuv and uvcc does not use this field.

int	is_active () const noexcept
	Check if the handle is active. More...

int	is_closing () const noexcept
	Check if the handle is closing or closed. More...

::uv_os_fd_t	fileno () const noexcept
	Get the platform dependent handle/file descriptor. More...

	operator const uv_t * () const noexcept

	operator uv_t * () noexcept

	operator bool () const noexcept
	Equivalent to `(id() and uv_status() >= 0)`.

void	attached (bool _state) const noexcept

bool	attached () const noexcept

Static Public Member Functions
static int	reset_mode () noexcept
	Reset TTY settings to default values. To be called when the program exits. More...

Static Public Member Functions inherited from uv::io
static io	guess_handle (uv::loop &, ::uv_file)
	Create an `io` handle object which actual type is derived from an existing file descriptor. More...

Detailed Description

TTY handle.

See also: libuv API documentation: uv_tty_t — TTY handle.

Definition at line 442 of file handle-stream.hpp.

Constructor & Destructor Documentation

◆ tty()

uv::tty::tty	(	uv::loop &	_loop,
		::uv_file	_fd,
		bool	_readable,
		bool	_set_blocking
	)

inline

Create a tty object from the given TTY file descriptor.

See also: libuv API documentation: uv_tty_init().

Definition at line 470 of file handle-stream.hpp.

Member Function Documentation

◆ set_mode()

int uv::tty::set_mode ( ::uv_tty_mode_t _mode )

inlinenoexcept

Set the TTY using the specified terminal mode.

See also: libuv API documentation: uv_tty_set_mode(), uv_tty_mode_t.

Definition at line 486 of file handle-stream.hpp.

◆ get_winsize()

int uv::tty::get_winsize	(	int &	_width,
		int &	_height
	)		const

inlinenoexcept

Get the current window size.

See also: libuv API documentation: uv_tty_get_winsize().

Definition at line 493 of file handle-stream.hpp.

◆ reset_mode()

static int uv::tty::reset_mode ( )

inlinestaticnoexcept

Reset TTY settings to default values. To be called when the program exits.

See also: libuv API documentation: uv_tty_reset_mode().

Definition at line 500 of file handle-stream.hpp.

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

handle-stream.hpp

Public Types

Public Member Functions