480 lines
48 KiB
HTML
480 lines
48 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: uvw::tty_handle Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="classuvw_1_1tty__handle.html">tty_handle</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classuvw_1_1tty__handle-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">uvw::tty_handle Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The tty handle.
|
|
<a href="classuvw_1_1tty__handle.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="tty_8h_source.html">tty.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for uvw::tty_handle:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1tty__handle__inherit__graph.png" border="0" usemap="#auvw_1_1tty__handle_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="auvw_1_1tty__handle_inherit__map" id="auvw_1_1tty__handle_inherit__map">
|
|
<area shape="rect" title="The tty handle." alt="" coords="95,328,206,353"/>
|
|
<area shape="rect" href="classuvw_1_1stream__handle.html" title=" " alt="" coords="71,240,230,280"/>
|
|
<area shape="rect" href="classuvw_1_1handle.html" title="Handle base class." alt="" coords="73,167,228,192"/>
|
|
<area shape="rect" href="classuvw_1_1resource.html" title=" " alt="" coords="80,79,221,119"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title="Wrapper class for underlying types." alt="" coords="5,5,133,31"/>
|
|
<area shape="rect" href="classuvw_1_1emitter.html" title=" " alt="" coords="158,5,309,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for uvw::tty_handle:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classuvw_1_1tty__handle__coll__graph.png" border="0" usemap="#auvw_1_1tty__handle_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="auvw_1_1tty__handle_coll__map" id="auvw_1_1tty__handle_coll__map">
|
|
<area shape="rect" title="The tty handle." alt="" coords="95,328,206,353"/>
|
|
<area shape="rect" href="classuvw_1_1stream__handle.html" title=" " alt="" coords="71,240,230,280"/>
|
|
<area shape="rect" href="classuvw_1_1handle.html" title="Handle base class." alt="" coords="73,167,228,192"/>
|
|
<area shape="rect" href="classuvw_1_1resource.html" title=" " alt="" coords="80,79,221,119"/>
|
|
<area shape="rect" href="structuvw_1_1uv__type.html" title="Wrapper class for underlying types." alt="" coords="5,5,133,31"/>
|
|
<area shape="rect" href="classuvw_1_1emitter.html" title=" " alt="" coords="158,5,309,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa9307635764951c0d8633e0b735dc2ee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1tty__handle.html#aa9307635764951c0d8633e0b735dc2ee">init</a> () final</td></tr>
|
|
<tr class="memdesc:aa9307635764951c0d8633e0b735dc2ee"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
|
<tr class="separator:aa9307635764951c0d8633e0b735dc2ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49af3a13ee30f7b02ec0d4a15a9361b9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1tty__handle.html#a49af3a13ee30f7b02ec0d4a15a9361b9">mode</a> (tty_mode m)</td></tr>
|
|
<tr class="memdesc:a49af3a13ee30f7b02ec0d4a15a9361b9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the TTY using the specified terminal mode. <br /></td></tr>
|
|
<tr class="separator:a49af3a13ee30f7b02ec0d4a15a9361b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca9a056acdf70d1e8fba7f3ab5351ff1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1tty__handle.html#aca9a056acdf70d1e8fba7f3ab5351ff1">reset_mode</a> () noexcept</td></tr>
|
|
<tr class="memdesc:aca9a056acdf70d1e8fba7f3ab5351ff1"><td class="mdescLeft"> </td><td class="mdescRight">Resets TTY settings to default values. <br /></td></tr>
|
|
<tr class="separator:aca9a056acdf70d1e8fba7f3ab5351ff1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f9a002b2802f162f1afff50b9f1306d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structuvw_1_1win__size.html">win_size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1tty__handle.html#a9f9a002b2802f162f1afff50b9f1306d">get_win_size</a> ()</td></tr>
|
|
<tr class="memdesc:a9f9a002b2802f162f1afff50b9f1306d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current Window size. <br /></td></tr>
|
|
<tr class="separator:a9f9a002b2802f162f1afff50b9f1306d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bac42546f774bf99513537eea0fcd60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1tty__handle.html#a7bac42546f774bf99513537eea0fcd60">vterm_state</a> (tty_vtermstate s) const noexcept</td></tr>
|
|
<tr class="memdesc:a7bac42546f774bf99513537eea0fcd60"><td class="mdescLeft"> </td><td class="mdescRight">Controls whether console virtual terminal sequences are processed by the library or console. <br /></td></tr>
|
|
<tr class="separator:a7bac42546f774bf99513537eea0fcd60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e8a2190f47b463ecfc3df7a3da46f23"><td class="memItemLeft" align="right" valign="top">tty_vtermstate </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1tty__handle.html#a3e8a2190f47b463ecfc3df7a3da46f23">vterm_state</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a3e8a2190f47b463ecfc3df7a3da46f23"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current state of whether console virtual terminal sequences are handled by the library or the console. <br /></td></tr>
|
|
<tr class="separator:a3e8a2190f47b463ecfc3df7a3da46f23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classuvw_1_1stream__handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1stream__handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1stream__handle.html">uvw::stream_handle< tty_handle, uv_tty_t ></a></td></tr>
|
|
<tr class="memitem:a74a48d00b23a4bd5a231d3f8bfaa655d inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a74a48d00b23a4bd5a231d3f8bfaa655d">shutdown</a> ()</td></tr>
|
|
<tr class="memdesc:a74a48d00b23a4bd5a231d3f8bfaa655d inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Shutdowns the outgoing (write) side of a duplex stream. <br /></td></tr>
|
|
<tr class="separator:a74a48d00b23a4bd5a231d3f8bfaa655d inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1022648bbcdd62fa84a411aa80c1057 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#ae1022648bbcdd62fa84a411aa80c1057">listen</a> (int backlog=DEFAULT_BACKLOG)</td></tr>
|
|
<tr class="memdesc:ae1022648bbcdd62fa84a411aa80c1057 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Starts listening for incoming connections. <br /></td></tr>
|
|
<tr class="separator:ae1022648bbcdd62fa84a411aa80c1057 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a005a77de769d10b660c198478ae03dba inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a005a77de769d10b660c198478ae03dba">accept</a> (S &ref)</td></tr>
|
|
<tr class="memdesc:a005a77de769d10b660c198478ae03dba inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Accepts incoming connections. <br /></td></tr>
|
|
<tr class="separator:a005a77de769d10b660c198478ae03dba inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fb471cfc6eec1dc2683e381ec828087 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a1fb471cfc6eec1dc2683e381ec828087">read</a> ()</td></tr>
|
|
<tr class="memdesc:a1fb471cfc6eec1dc2683e381ec828087 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Starts reading data from an incoming stream. <br /></td></tr>
|
|
<tr class="separator:a1fb471cfc6eec1dc2683e381ec828087 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae06ccaed032ab19ac2466ba35c5d1c9e inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#ae06ccaed032ab19ac2466ba35c5d1c9e">stop</a> ()</td></tr>
|
|
<tr class="memdesc:ae06ccaed032ab19ac2466ba35c5d1c9e inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Stops reading data from the stream. <br /></td></tr>
|
|
<tr class="separator:ae06ccaed032ab19ac2466ba35c5d1c9e inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8a3ac704e013ede496a3d998a74ebc7 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#ad8a3ac704e013ede496a3d998a74ebc7">write</a> (std::unique_ptr< char[], Deleter > data, unsigned int len)</td></tr>
|
|
<tr class="memdesc:ad8a3ac704e013ede496a3d998a74ebc7 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Writes data to the stream. <br /></td></tr>
|
|
<tr class="separator:ad8a3ac704e013ede496a3d998a74ebc7 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd0895fadb7985f8b437ff3bce62a80b inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#afd0895fadb7985f8b437ff3bce62a80b">write</a> (char *data, unsigned int len)</td></tr>
|
|
<tr class="memdesc:afd0895fadb7985f8b437ff3bce62a80b inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Writes data to the stream. <br /></td></tr>
|
|
<tr class="separator:afd0895fadb7985f8b437ff3bce62a80b inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28a943387b69c05b7bb6469f7042ca08 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a28a943387b69c05b7bb6469f7042ca08">write</a> (S &send, std::unique_ptr< char[], Deleter > data, unsigned int len)</td></tr>
|
|
<tr class="memdesc:a28a943387b69c05b7bb6469f7042ca08 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Extended write function for sending handles over a pipe handle. <br /></td></tr>
|
|
<tr class="separator:a28a943387b69c05b7bb6469f7042ca08 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aace2532231266f660ad26876602eaad0 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#aace2532231266f660ad26876602eaad0">write</a> (S &send, char *data, unsigned int len)</td></tr>
|
|
<tr class="memdesc:aace2532231266f660ad26876602eaad0 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Extended write function for sending handles over a pipe handle. <br /></td></tr>
|
|
<tr class="separator:aace2532231266f660ad26876602eaad0 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af07b07065609821932537dc23773b2ed inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#af07b07065609821932537dc23773b2ed">try_write</a> (std::unique_ptr< char[]> data, unsigned int len)</td></tr>
|
|
<tr class="memdesc:af07b07065609821932537dc23773b2ed inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Queues a write request if it can be completed immediately. <br /></td></tr>
|
|
<tr class="separator:af07b07065609821932537dc23773b2ed inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0b12e5126cba8c84a3fdbb01cc3b81a inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#aa0b12e5126cba8c84a3fdbb01cc3b81a">try_write</a> (std::unique_ptr< char[]> data, unsigned int len, <a class="el" href="classuvw_1_1stream__handle.html">stream_handle</a>< V, W > &send)</td></tr>
|
|
<tr class="memdesc:aa0b12e5126cba8c84a3fdbb01cc3b81a inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Queues a write request if it can be completed immediately. <br /></td></tr>
|
|
<tr class="separator:aa0b12e5126cba8c84a3fdbb01cc3b81a inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d56a5108fd6f3fd7f11f7e5507c7727 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a6d56a5108fd6f3fd7f11f7e5507c7727">try_write</a> (char *data, unsigned int len)</td></tr>
|
|
<tr class="memdesc:a6d56a5108fd6f3fd7f11f7e5507c7727 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Queues a write request if it can be completed immediately. <br /></td></tr>
|
|
<tr class="separator:a6d56a5108fd6f3fd7f11f7e5507c7727 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a729ff5d6b7da6af3c70068a3dfca5204 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a729ff5d6b7da6af3c70068a3dfca5204">try_write</a> (char *data, unsigned int len, <a class="el" href="classuvw_1_1stream__handle.html">stream_handle</a>< V, W > &send)</td></tr>
|
|
<tr class="memdesc:a729ff5d6b7da6af3c70068a3dfca5204 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Queues a write request if it can be completed immediately. <br /></td></tr>
|
|
<tr class="separator:a729ff5d6b7da6af3c70068a3dfca5204 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a459eccecaee81d4a8619e1a073e81a69 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a459eccecaee81d4a8619e1a073e81a69">readable</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a459eccecaee81d4a8619e1a073e81a69 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the stream is readable. <br /></td></tr>
|
|
<tr class="separator:a459eccecaee81d4a8619e1a073e81a69 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09ac22ea79bf27479eedbda9ac1101f0 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a09ac22ea79bf27479eedbda9ac1101f0">writable</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a09ac22ea79bf27479eedbda9ac1101f0 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the stream is writable. <br /></td></tr>
|
|
<tr class="separator:a09ac22ea79bf27479eedbda9ac1101f0 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a824348c23445390d58fb393f731acdee inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a824348c23445390d58fb393f731acdee">blocking</a> (bool enable=false)</td></tr>
|
|
<tr class="memdesc:a824348c23445390d58fb393f731acdee inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables blocking mode for a stream. <br /></td></tr>
|
|
<tr class="separator:a824348c23445390d58fb393f731acdee inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a455c3e4cccd8f8119d1f251b809ea810 inherit pub_methods_classuvw_1_1stream__handle"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1stream__handle.html#a455c3e4cccd8f8119d1f251b809ea810">write_queue_size</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a455c3e4cccd8f8119d1f251b809ea810 inherit pub_methods_classuvw_1_1stream__handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the amount of queued bytes waiting to be sent. <br /></td></tr>
|
|
<tr class="separator:a455c3e4cccd8f8119d1f251b809ea810 inherit pub_methods_classuvw_1_1stream__handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classuvw_1_1handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1handle.html">uvw::handle< T, U, E ></a></td></tr>
|
|
<tr class="memitem:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a9e28e1855691dd1af105626ed11f3ac4">handle_category</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a80c5ba8c4db128cc525406e998549b96">category</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the category of the handle. <br /></td></tr>
|
|
<tr class="separator:a80c5ba8c4db128cc525406e998549b96 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a3954d5751b5b6ebb0c90c195e9b94edd">handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a88018be1fa3105e958c50a9f1881baa9">type</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the handle. <br /></td></tr>
|
|
<tr class="separator:a88018be1fa3105e958c50a9f1881baa9 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a938d3ac6e5cc78f9442f9bb851170643">active</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the handle is active. <br /></td></tr>
|
|
<tr class="separator:a938d3ac6e5cc78f9442f9bb851170643 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#ae93cbf2156f0d673093e48832104a3cc">closing</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a handle is closing or closed. <br /></td></tr>
|
|
<tr class="separator:ae93cbf2156f0d673093e48832104a3cc inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a3648ed9805e8d0e8963f137f8584e483">close</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Request handle to be closed. <br /></td></tr>
|
|
<tr class="separator:a3648ed9805e8d0e8963f137f8584e483 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a2f0d788997368ab1af2dc475126a46d2">reference</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Reference the given handle. <br /></td></tr>
|
|
<tr class="separator:a2f0d788997368ab1af2dc475126a46d2 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a83a91d1353c19f1a05aace78dc2cc453">unreference</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Unreference the given handle. <br /></td></tr>
|
|
<tr class="separator:a83a91d1353c19f1a05aace78dc2cc453 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a1403f961ab40063f79c4a293c78ed63c">referenced</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the given handle referenced. <br /></td></tr>
|
|
<tr class="separator:a1403f961ab40063f79c4a293c78ed63c inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a5852080ba1fd71a302c2424cf2df9a27">size</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the underlying handle type. <br /></td></tr>
|
|
<tr class="separator:a5852080ba1fd71a302c2424cf2df9a27 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#aa99406ca909aeaac17522959db8c71a4">send_buffer_size</a> ()</td></tr>
|
|
<tr class="memdesc:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the send buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:aa99406ca909aeaac17522959db8c71a4 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a917ab9c1f011232b50f9980f29167ee2">send_buffer_size</a> (int value)</td></tr>
|
|
<tr class="memdesc:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the send buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:a917ab9c1f011232b50f9980f29167ee2 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a7a3337ef0c68ed5ba0e9bea0e2e90539">recv_buffer_size</a> ()</td></tr>
|
|
<tr class="memdesc:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the receive buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:a7a3337ef0c68ed5ba0e9bea0e2e90539 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#ace23bb725f6f80ae7a611f5228ad9f8d">recv_buffer_size</a> (int value)</td></tr>
|
|
<tr class="memdesc:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the receive buffer used for the socket. <br /></td></tr>
|
|
<tr class="separator:ace23bb725f6f80ae7a611f5228ad9f8d inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#a1a4f79e341b89257a11403ee0739f2b4">os_file_descriptor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1handle.html#a0ce9568c94aa0122ff4cee6a57b4fae5">fd</a> () const</td></tr>
|
|
<tr class="memdesc:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="mdescLeft"> </td><td class="mdescRight">Gets the platform dependent file descriptor equivalent. <br /></td></tr>
|
|
<tr class="separator:a0ce9568c94aa0122ff4cee6a57b4fae5 inherit pub_methods_classuvw_1_1handle"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classuvw_1_1resource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1resource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1resource.html">uvw::resource< T, U, close_event, E... ></a></td></tr>
|
|
<tr class="memitem:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< R > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1resource.html#a7c05e988ebaa14d1dbbc781951dc3a88">data</a> () const</td></tr>
|
|
<tr class="memdesc:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="mdescLeft"> </td><td class="mdescRight">Gets user-defined data. <code>uvw</code> won't use this field in any case. <br /></td></tr>
|
|
<tr class="separator:a7c05e988ebaa14d1dbbc781951dc3a88 inherit pub_methods_classuvw_1_1resource"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1resource.html#a759079eb405e5d2fda795d199d8efa80">data</a> (std::shared_ptr< void > udata)</td></tr>
|
|
<tr class="memdesc:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="mdescLeft"> </td><td class="mdescRight">Sets arbitrary data. <code>uvw</code> won't use this field in any case. <br /></td></tr>
|
|
<tr class="separator:a759079eb405e5d2fda795d199d8efa80 inherit pub_methods_classuvw_1_1resource"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structuvw_1_1uv__type"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structuvw_1_1uv__type')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structuvw_1_1uv__type.html">uvw::uv_type< U ></a></td></tr>
|
|
<tr class="memitem:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">init</a> ()</td></tr>
|
|
<tr class="memdesc:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
|
<tr class="separator:ae97ffacc0b381610d8d18a62a957a69c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1loop.html">loop</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#ae03b0ebbae151c6157c5ba6a24a39a7b">parent</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the loop from which the resource was originated. <br /></td></tr>
|
|
<tr class="separator:ae03b0ebbae151c6157c5ba6a24a39a7b inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">const U * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
|
<tr class="separator:a06a6cb7ebde27aa348e340b76e49c6ae inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memItemLeft" align="right" valign="top">U * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1uv__type.html#af4b6f395815f2e99302b5f09be23767c">raw</a> () noexcept</td></tr>
|
|
<tr class="memdesc:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying raw data structure. <br /></td></tr>
|
|
<tr class="separator:af4b6f395815f2e99302b5f09be23767c inherit pub_methods_structuvw_1_1uv__type"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classuvw_1_1emitter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1emitter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classuvw_1_1emitter.html">uvw::emitter< T, E... ></a></td></tr>
|
|
<tr class="memitem:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1emitter.html#ab913fa1c005a33c73b2eb2b0d1051b1f">on</a> (listener_t< U > f)</td></tr>
|
|
<tr class="memdesc:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Registers a long-lived listener with the event emitter. <br /></td></tr>
|
|
<tr class="separator:ab913fa1c005a33c73b2eb2b0d1051b1f inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top"><a id="accff5c096692f5eebbe941189644e69d" name="accff5c096692f5eebbe941189644e69d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reset</b> () noexcept</td></tr>
|
|
<tr class="memdesc:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects the listener for the given event type. <br /></td></tr>
|
|
<tr class="separator:accff5c096692f5eebbe941189644e69d inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top"><a id="aa71435e74e775cfa7012fe2e52ca5193" name="aa71435e74e775cfa7012fe2e52ca5193"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reset</b> () noexcept</td></tr>
|
|
<tr class="memdesc:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects all listeners. <br /></td></tr>
|
|
<tr class="separator:aa71435e74e775cfa7012fe2e52ca5193 inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1emitter.html#ac02a29fe156faba7571b50450fc4f780">has</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="mdescLeft"> </td><td class="mdescRight">Checks if there is a listener registered for the specific event. <br /></td></tr>
|
|
<tr class="separator:ac02a29fe156faba7571b50450fc4f780 inherit pub_methods_classuvw_1_1emitter"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The tty handle. </p>
|
|
<p>TTY handles represent a stream for the console.</p>
|
|
<p>To create a <code><a class="el" href="classuvw_1_1tty__handle.html" title="The tty handle.">tty_handle</a></code> through a <code>loop</code>, arguments follow:</p>
|
|
<ul>
|
|
<li>A valid file_handle. Usually the file descriptor will be:<ul>
|
|
<li><code><a class="el" href="namespaceuvw.html#a3691af2bb44186858cde323ca9f21fee">uvw::std_in</a></code> or <code>0</code> for <code>stdin</code></li>
|
|
<li><code><a class="el" href="namespaceuvw.html#aed16ccd324bef8280d2a38e321ad063d">uvw::std_out</a></code> or <code>1</code> for <code>stdout</code></li>
|
|
<li><code><a class="el" href="namespaceuvw.html#aa1f6dd38215987004990ad6e2111db4e">uvw::std_err</a></code> or <code>2</code> for <code>stderr</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>A boolean value that specifies the plan on calling <code><a class="el" href="classuvw_1_1stream__handle.html#a1fb471cfc6eec1dc2683e381ec828087" title="Starts reading data from an incoming stream.">read()</a></code> with this stream. Remember that <code>stdin</code> is readable, <code>stdout</code> is not.</li>
|
|
</ul>
|
|
<p>See the official <a href="http://docs.libuv.org/en/v1.x/tty.html#c.uv_tty_init">documentation</a> for further details. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="tty_8h_source.html#l00050">50</a> of file <a class="el" href="tty_8h_source.html">tty.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a9f9a002b2802f162f1afff50b9f1306d" name="a9f9a002b2802f162f1afff50b9f1306d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f9a002b2802f162f1afff50b9f1306d">◆ </a></span>get_win_size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structuvw_1_1win__size.html">win_size</a> uvw::tty_handle::get_win_size </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current Window size. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current Window size or <code>{-1, -1}</code> in case of errors. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa9307635764951c0d8633e0b735dc2ee" name="aa9307635764951c0d8633e0b735dc2ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa9307635764951c0d8633e0b735dc2ee">◆ </a></span>init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int uvw::tty_handle::init </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the handle. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="structuvw_1_1uv__type.html#ae97ffacc0b381610d8d18a62a957a69c">uvw::uv_type< U ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49af3a13ee30f7b02ec0d4a15a9361b9" name="a49af3a13ee30f7b02ec0d4a15a9361b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49af3a13ee30f7b02ec0d4a15a9361b9">◆ </a></span>mode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool uvw::tty_handle::mode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tty_mode </td>
|
|
<td class="paramname"><em>m</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the TTY using the specified terminal mode. </p>
|
|
<p>Available modes are:</p>
|
|
<ul>
|
|
<li><code>TTY::tty_mode::NORMAL</code></li>
|
|
<li><code>TTY::tty_mode::RAW</code></li>
|
|
<li><code>TTY::tty_mode::IO</code></li>
|
|
</ul>
|
|
<p>See the official <a href="http://docs.libuv.org/en/v1.x/tty.html#c.uv_tty_mode_t">documentation</a> for further details.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">m</td><td>The mode to be set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aca9a056acdf70d1e8fba7f3ab5351ff1" name="aca9a056acdf70d1e8fba7f3ab5351ff1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca9a056acdf70d1e8fba7f3ab5351ff1">◆ </a></span>reset_mode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool uvw::tty_handle::reset_mode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets TTY settings to default values. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e8a2190f47b463ecfc3df7a3da46f23" name="a3e8a2190f47b463ecfc3df7a3da46f23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e8a2190f47b463ecfc3df7a3da46f23">◆ </a></span>vterm_state() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">tty_vtermstate uvw::tty_handle::vterm_state </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current state of whether console virtual terminal sequences are handled by the library or the console. </p>
|
|
<p>This function is not implemented on Unix.</p>
|
|
<p>Available states are:</p>
|
|
<ul>
|
|
<li><code>TTY::tty_vtermstate::SUPPORTED</code></li>
|
|
<li><code>TTY::tty_vtermstate::UNSUPPORTED</code></li>
|
|
</ul>
|
|
<p>See the official <a href="http://docs.libuv.org/en/v1.x/tty.html#c.uv_tty_vtermstate_t">documentation</a> for further details.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current state. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7bac42546f774bf99513537eea0fcd60" name="a7bac42546f774bf99513537eea0fcd60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7bac42546f774bf99513537eea0fcd60">◆ </a></span>vterm_state() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void uvw::tty_handle::vterm_state </td>
|
|
<td>(</td>
|
|
<td class="paramtype">tty_vtermstate </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Controls whether console virtual terminal sequences are processed by the library or console. </p>
|
|
<p>This function is only meaningful on Windows systems. On Unix it is silently ignored.</p>
|
|
<p>Available states are:</p>
|
|
<ul>
|
|
<li><code>TTY::tty_vtermstate::SUPPORTED</code></li>
|
|
<li><code>TTY::tty_vtermstate::UNSUPPORTED</code></li>
|
|
</ul>
|
|
<p>See the official <a href="http://docs.libuv.org/en/v1.x/tty.html#c.uv_tty_vtermstate_t">documentation</a> for further details.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">s</td><td>The state to be set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/uvw/<a class="el" href="tty_8h_source.html">tty.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|