614 lines
54 KiB
HTML
614 lines
54 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::pipe_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_1pipe__handle.html">pipe_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_1pipe__handle-members.html">List of all members</a> </div>
|
||
<div class="headertitle"><div class="title">uvw::pipe_handle Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p>The pipe handle.
|
||
<a href="classuvw_1_1pipe__handle.html#details">More...</a></p>
|
||
|
||
<p><code>#include <<a class="el" href="pipe_8h_source.html">pipe.h</a>></code></p>
|
||
<div class="dynheader">
|
||
Inheritance diagram for uvw::pipe_handle:</div>
|
||
<div class="dyncontent">
|
||
<div class="center"><img src="classuvw_1_1pipe__handle__inherit__graph.png" border="0" usemap="#auvw_1_1pipe__handle_inherit__map" alt="Inheritance graph"/></div>
|
||
<map name="auvw_1_1pipe__handle_inherit__map" id="auvw_1_1pipe__handle_inherit__map">
|
||
<area shape="rect" title="The pipe handle." alt="" coords="91,328,211,353"/>
|
||
<area shape="rect" href="classuvw_1_1stream__handle.html" title=" " alt="" coords="62,240,239,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::pipe_handle:</div>
|
||
<div class="dyncontent">
|
||
<div class="center"><img src="classuvw_1_1pipe__handle__coll__graph.png" border="0" usemap="#auvw_1_1pipe__handle_coll__map" alt="Collaboration graph"/></div>
|
||
<map name="auvw_1_1pipe__handle_coll__map" id="auvw_1_1pipe__handle_coll__map">
|
||
<area shape="rect" title="The pipe handle." alt="" coords="91,328,211,353"/>
|
||
<area shape="rect" href="classuvw_1_1stream__handle.html" title=" " alt="" coords="62,240,239,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:acd39d8dc12cd965b1ea2e0833a8eb33a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#acd39d8dc12cd965b1ea2e0833a8eb33a">init</a> () final</td></tr>
|
||
<tr class="memdesc:acd39d8dc12cd965b1ea2e0833a8eb33a"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the handle. <br /></td></tr>
|
||
<tr class="separator:acd39d8dc12cd965b1ea2e0833a8eb33a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a26589dab7b89324217dee2939ab3dd9f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#a26589dab7b89324217dee2939ab3dd9f">open</a> (<a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> file)</td></tr>
|
||
<tr class="memdesc:a26589dab7b89324217dee2939ab3dd9f"><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing file descriptor or HANDLE as a pipe. <br /></td></tr>
|
||
<tr class="separator:a26589dab7b89324217dee2939ab3dd9f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aa490105af71a1f59f2b5ec4637270194"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#aa490105af71a1f59f2b5ec4637270194">bind</a> (const std::string &name)</td></tr>
|
||
<tr class="memdesc:aa490105af71a1f59f2b5ec4637270194"><td class="mdescLeft"> </td><td class="mdescRight">bind Binds the pipe to a file path (Unix) or a name (Windows). <br /></td></tr>
|
||
<tr class="separator:aa490105af71a1f59f2b5ec4637270194"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a8fdb960c599bf4ab281dc2e19e8241a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#a8fdb960c599bf4ab281dc2e19e8241a2">connect</a> (const std::string &name)</td></tr>
|
||
<tr class="memdesc:a8fdb960c599bf4ab281dc2e19e8241a2"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the Unix domain socket or the named pipe. <br /></td></tr>
|
||
<tr class="separator:a8fdb960c599bf4ab281dc2e19e8241a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aab27c379653ef2c49ae861a7b9039637"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#aab27c379653ef2c49ae861a7b9039637">sock</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:aab27c379653ef2c49ae861a7b9039637"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the Unix domain socket or the named pipe. <br /></td></tr>
|
||
<tr class="separator:aab27c379653ef2c49ae861a7b9039637"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a77f5e62e504a69e47a84b04e0e7a0e67"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#a77f5e62e504a69e47a84b04e0e7a0e67">peer</a> () const noexcept</td></tr>
|
||
<tr class="memdesc:a77f5e62e504a69e47a84b04e0e7a0e67"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the Unix domain socket or the named pipe to which the handle is connected. <br /></td></tr>
|
||
<tr class="separator:a77f5e62e504a69e47a84b04e0e7a0e67"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ae4cc20d486d44ee915eb2d526107bac8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#ae4cc20d486d44ee915eb2d526107bac8">pending</a> (int count) noexcept</td></tr>
|
||
<tr class="memdesc:ae4cc20d486d44ee915eb2d526107bac8"><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of pending pipe this instance can handle. <br /></td></tr>
|
||
<tr class="separator:ae4cc20d486d44ee915eb2d526107bac8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a32692d6af15e300e3f147ff13d251999"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#a32692d6af15e300e3f147ff13d251999">pending</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a32692d6af15e300e3f147ff13d251999"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of pending pipe this instance can handle. <br /></td></tr>
|
||
<tr class="separator:a32692d6af15e300e3f147ff13d251999"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5c8a6d67e9ec7a6507d8f181f3fb1f60"><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_1pipe__handle.html#a5c8a6d67e9ec7a6507d8f181f3fb1f60">receive</a> () noexcept</td></tr>
|
||
<tr class="memdesc:a5c8a6d67e9ec7a6507d8f181f3fb1f60"><td class="mdescLeft"> </td><td class="mdescRight">Used to receive handles over IPC pipes. <br /></td></tr>
|
||
<tr class="separator:a5c8a6d67e9ec7a6507d8f181f3fb1f60"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:af2470cc253767f663c57ce632a70c0e0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1pipe__handle.html#af2470cc253767f663c57ce632a70c0e0">chmod</a> (chmod_flags flags) noexcept</td></tr>
|
||
<tr class="memdesc:af2470cc253767f663c57ce632a70c0e0"><td class="mdescLeft"> </td><td class="mdescRight">Alters pipe permissions. <br /></td></tr>
|
||
<tr class="separator:af2470cc253767f663c57ce632a70c0e0"><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< pipe_handle, uv_pipe_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 pipe handle. </p>
|
||
<p>Pipe handles provide an abstraction over local domain sockets on Unix and named pipes on Windows.</p>
|
||
<p>To create a <code><a class="el" href="classuvw_1_1pipe__handle.html" title="The pipe handle.">pipe_handle</a></code> through a <code>loop</code>, arguments follow:</p>
|
||
<ul>
|
||
<li>An optional boolean value that indicates if this pipe will be used for handle passing between processes. </li>
|
||
</ul>
|
||
|
||
<p class="definition">Definition at line <a class="el" href="pipe_8h_source.html#l00038">38</a> of file <a class="el" href="pipe_8h_source.html">pipe.h</a>.</p>
|
||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
<a id="aa490105af71a1f59f2b5ec4637270194" name="aa490105af71a1f59f2b5ec4637270194"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aa490105af71a1f59f2b5ec4637270194">◆ </a></span>bind()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::pipe_handle::bind </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string & </td>
|
||
<td class="paramname"><em>name</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>bind Binds the pipe to a file path (Unix) or a name (Windows). </p>
|
||
<p>Paths on Unix get truncated typically between 92 and 108 bytes.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">name</td><td>A valid file path. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="af2470cc253767f663c57ce632a70c0e0" name="af2470cc253767f663c57ce632a70c0e0"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#af2470cc253767f663c57ce632a70c0e0">◆ </a></span>chmod()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::pipe_handle::chmod </td>
|
||
<td>(</td>
|
||
<td class="paramtype">chmod_flags </td>
|
||
<td class="paramname"><em>flags</em></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>Alters pipe permissions. </p>
|
||
<p>It allows the pipe to be accessed from processes run by different users.</p>
|
||
<p>Available flags are:</p>
|
||
<ul>
|
||
<li><code>pipe_handle::chmod_flags::READABLE</code></li>
|
||
<li><code>pipe_handle::chmod_flags::WRITABLE</code></li>
|
||
</ul>
|
||
<p>See the official <a href="http://docs.libuv.org/en/v1.x/pipe.html#c.uv_pipe_chmod">documentation</a> for further details.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">flags</td><td>A valid set of flags. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a8fdb960c599bf4ab281dc2e19e8241a2" name="a8fdb960c599bf4ab281dc2e19e8241a2"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a8fdb960c599bf4ab281dc2e19e8241a2">◆ </a></span>connect()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::pipe_handle::connect </td>
|
||
<td>(</td>
|
||
<td class="paramtype">const std::string & </td>
|
||
<td class="paramname"><em>name</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Connects to the Unix domain socket or the named pipe. </p>
|
||
<p>Paths on Unix get truncated typically between 92 and 108 bytes.<br />
|
||
A connect event is emitted when the connection has been established.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">name</td><td>A valid domain socket or named pipe. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="acd39d8dc12cd965b1ea2e0833a8eb33a" name="acd39d8dc12cd965b1ea2e0833a8eb33a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#acd39d8dc12cd965b1ea2e0833a8eb33a">◆ </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::pipe_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="a26589dab7b89324217dee2939ab3dd9f" name="a26589dab7b89324217dee2939ab3dd9f"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a26589dab7b89324217dee2939ab3dd9f">◆ </a></span>open()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">int uvw::pipe_handle::open </td>
|
||
<td>(</td>
|
||
<td class="paramtype"><a class="el" href="namespaceuvw.html#a28622e02bfff09ba6cf8a86a929917ee">file_handle</a> </td>
|
||
<td class="paramname"><em>file</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Opens an existing file descriptor or HANDLE as a pipe. </p>
|
||
<p>The passed file descriptor or HANDLE is not checked for its type, but it’s required that it represents a valid pipe.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">file</td><td>A valid file handle (either a file descriptor or a HANDLE). </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Underlying return value. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a77f5e62e504a69e47a84b04e0e7a0e67" name="a77f5e62e504a69e47a84b04e0e7a0e67"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a77f5e62e504a69e47a84b04e0e7a0e67">◆ </a></span>peer()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::string uvw::pipe_handle::peer </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 name of the Unix domain socket or the named pipe to which the handle is connected. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The name of the Unix domain socket or the named pipe to which the handle is connected, an empty string in case of errors. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a32692d6af15e300e3f147ff13d251999" name="a32692d6af15e300e3f147ff13d251999"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a32692d6af15e300e3f147ff13d251999">◆ </a></span>pending() <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">int uvw::pipe_handle::pending </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>Gets the number of pending pipe this instance can handle. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The number of pending pipe this instance can handle. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="ae4cc20d486d44ee915eb2d526107bac8" name="ae4cc20d486d44ee915eb2d526107bac8"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#ae4cc20d486d44ee915eb2d526107bac8">◆ </a></span>pending() <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::pipe_handle::pending </td>
|
||
<td>(</td>
|
||
<td class="paramtype">int </td>
|
||
<td class="paramname"><em>count</em></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>Sets the number of pending pipe this instance can handle. </p>
|
||
<p>This method can be used to set the number of pending pipe this instance handles when the pipe server is waiting for connections.<br />
|
||
Note that this setting applies to Windows only.</p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">count</td><td>The number of accepted pending pipe. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5c8a6d67e9ec7a6507d8f181f3fb1f60" name="a5c8a6d67e9ec7a6507d8f181f3fb1f60"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5c8a6d67e9ec7a6507d8f181f3fb1f60">◆ </a></span>receive()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="namespaceuvw.html#a3954d5751b5b6ebb0c90c195e9b94edd">handle_type</a> uvw::pipe_handle::receive </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>Used to receive handles over IPC pipes. </p>
|
||
<p>Steps to be done:</p>
|
||
<ul>
|
||
<li>Call <code><a class="el" href="classuvw_1_1pipe__handle.html#a32692d6af15e300e3f147ff13d251999" title="Gets the number of pending pipe this instance can handle.">pending()</a></code>, if it’s greater than zero then proceed.</li>
|
||
<li>Initialize a handle of the given type, as returned by <code><a class="el" href="classuvw_1_1pipe__handle.html#a5c8a6d67e9ec7a6507d8f181f3fb1f60" title="Used to receive handles over IPC pipes.">receive()</a></code>.</li>
|
||
<li>Call <code>accept(pipe, handle)</code>.</li>
|
||
</ul>
|
||
<dl class="section return"><dt>Returns</dt><dd>The type of the pending handle. Possible values are:</dd></dl>
|
||
<ul>
|
||
<li><code>handle_type::PIPE</code></li>
|
||
<li><code>handle_type::TCP</code></li>
|
||
<li><code>handle_type::UDP</code></li>
|
||
<li><code>handle_type::UNKNOWN</code> </li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="aab27c379653ef2c49ae861a7b9039637" name="aab27c379653ef2c49ae861a7b9039637"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aab27c379653ef2c49ae861a7b9039637">◆ </a></span>sock()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="mlabels">
|
||
<tr>
|
||
<td class="mlabels-left">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">std::string uvw::pipe_handle::sock </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 name of the Unix domain socket or the named pipe. </p>
|
||
<dl class="section return"><dt>Returns</dt><dd>The name of the Unix domain socket or the named pipe, an empty string in case of errors. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
<li>src/uvw/<a class="el" href="pipe_8h_source.html">pipe.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>
|