luo980/uvw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
8837a33bd7
uvw/classuvw_1_1Handle.html
Michele Caini 8837a33bd7 updated doc: v2.8.0
2020-10-15 09:33:44 +02:00

709 lines
51 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: uvw::Handle&lt; T, U &gt; Class Template 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uvw
&#160;<span id="projectnumber">2.8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_1Handle.html">Handle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classuvw_1_1Handle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uvw::Handle&lt; T, U &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classuvw_1_1Handle.html" title="Handle base class.">Handle</a> base class.
<a href="classuvw_1_1Handle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="handle_8hpp_source.html">handle.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for uvw::Handle&lt; T, U &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1Handle__inherit__graph.png" border="0" usemap="#auvw_1_1Handle_3_01T_00_01U_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="uvw_1_1Handle_3_01T_00_01U_01_4_inherit__map" id="auvw_1_1Handle_3_01T_00_01U_01_4_inherit__map">
<area shape="rect" title="Handle base class." alt="" coords="83,169,222,196"/>
<area shape="rect" href="classuvw_1_1StreamHandle.html" title="The StreamHandle handle." alt="" coords="82,244,223,285"/>
<area shape="rect" href="classuvw_1_1Resource.html" title="Common class for almost all the resources available in uvw." alt="" coords="75,95,230,121"/>
<area shape="rect" href="classuvw_1_1UnderlyingType.html" title="Wrapper class for underlying types." alt="" coords="5,5,145,47"/>
<area shape="rect" href="classuvw_1_1Emitter.html" title="Event emitter base class." alt="" coords="169,13,293,39"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for uvw::Handle&lt; T, U &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1Handle__coll__graph.png" border="0" usemap="#auvw_1_1Handle_3_01T_00_01U_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="uvw_1_1Handle_3_01T_00_01U_01_4_coll__map" id="auvw_1_1Handle_3_01T_00_01U_01_4_coll__map">
<area shape="rect" title="Handle base class." alt="" coords="83,169,222,196"/>
<area shape="rect" href="classuvw_1_1Resource.html" title="Common class for almost all the resources available in uvw." alt="" coords="75,95,230,121"/>
<area shape="rect" href="classuvw_1_1UnderlyingType.html" title="Wrapper class for underlying types." alt="" coords="5,5,145,47"/>
<area shape="rect" href="classuvw_1_1Emitter.html" title="Event emitter base class." alt="" coords="169,13,293,39"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2f01819d9d8649d57841f4299f0adffa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#aa3ae4a038de60a69b2513a039add1e48">HandleCategory</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a2f01819d9d8649d57841f4299f0adffa">category</a> () const noexcept</td></tr>
<tr class="memdesc:a2f01819d9d8649d57841f4299f0adffa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the category of the handle. <a href="classuvw_1_1Handle.html#a2f01819d9d8649d57841f4299f0adffa">More...</a><br /></td></tr>
<tr class="separator:a2f01819d9d8649d57841f4299f0adffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ab7b63ff4b7be5ba3fc48dc7e094530"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#ad8b4c4aaf16bbe0b08218b42fbf32f0e">HandleType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a5ab7b63ff4b7be5ba3fc48dc7e094530">type</a> () const noexcept</td></tr>
<tr class="memdesc:a5ab7b63ff4b7be5ba3fc48dc7e094530"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the type of the handle. <a href="classuvw_1_1Handle.html#a5ab7b63ff4b7be5ba3fc48dc7e094530">More...</a><br /></td></tr>
<tr class="separator:a5ab7b63ff4b7be5ba3fc48dc7e094530"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a788704c3e891b90d28494f1ecc456803"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a788704c3e891b90d28494f1ecc456803">active</a> () const noexcept</td></tr>
<tr class="memdesc:a788704c3e891b90d28494f1ecc456803"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the handle is active. <a href="classuvw_1_1Handle.html#a788704c3e891b90d28494f1ecc456803">More...</a><br /></td></tr>
<tr class="separator:a788704c3e891b90d28494f1ecc456803"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a150929f3f90dd31d09f5a1d0441ddf07"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a150929f3f90dd31d09f5a1d0441ddf07">closing</a> () const noexcept</td></tr>
<tr class="memdesc:a150929f3f90dd31d09f5a1d0441ddf07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle is closing or closed. <a href="classuvw_1_1Handle.html#a150929f3f90dd31d09f5a1d0441ddf07">More...</a><br /></td></tr>
<tr class="separator:a150929f3f90dd31d09f5a1d0441ddf07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6bfe6acf120b9c31c2cbe51b1151603"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#ab6bfe6acf120b9c31c2cbe51b1151603">close</a> () noexcept</td></tr>
<tr class="memdesc:ab6bfe6acf120b9c31c2cbe51b1151603"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classuvw_1_1Request.html" title="Request base class.">Request</a> handle to be closed. <a href="classuvw_1_1Handle.html#ab6bfe6acf120b9c31c2cbe51b1151603">More...</a><br /></td></tr>
<tr class="separator:ab6bfe6acf120b9c31c2cbe51b1151603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d7c8e8229d6e1680c6b6f337ecfcfc7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a2d7c8e8229d6e1680c6b6f337ecfcfc7">reference</a> () noexcept</td></tr>
<tr class="memdesc:a2d7c8e8229d6e1680c6b6f337ecfcfc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference the given handle. <a href="classuvw_1_1Handle.html#a2d7c8e8229d6e1680c6b6f337ecfcfc7">More...</a><br /></td></tr>
<tr class="separator:a2d7c8e8229d6e1680c6b6f337ecfcfc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d1df5f35276ab9c2a3696ef7b2e1761"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a7d1df5f35276ab9c2a3696ef7b2e1761">unreference</a> () noexcept</td></tr>
<tr class="memdesc:a7d1df5f35276ab9c2a3696ef7b2e1761"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unreference the given handle. <a href="classuvw_1_1Handle.html#a7d1df5f35276ab9c2a3696ef7b2e1761">More...</a><br /></td></tr>
<tr class="separator:a7d1df5f35276ab9c2a3696ef7b2e1761"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeccf6a30e939c34c5370b5abfeb49e34"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#aeccf6a30e939c34c5370b5abfeb49e34">referenced</a> () const noexcept</td></tr>
<tr class="memdesc:aeccf6a30e939c34c5370b5abfeb49e34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the given handle referenced. <a href="classuvw_1_1Handle.html#aeccf6a30e939c34c5370b5abfeb49e34">More...</a><br /></td></tr>
<tr class="separator:aeccf6a30e939c34c5370b5abfeb49e34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9f911fc627f3feb32fefd67a7d5344"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#aaf9f911fc627f3feb32fefd67a7d5344">size</a> () const noexcept</td></tr>
<tr class="memdesc:aaf9f911fc627f3feb32fefd67a7d5344"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the underlying handle type. <a href="classuvw_1_1Handle.html#aaf9f911fc627f3feb32fefd67a7d5344">More...</a><br /></td></tr>
<tr class="separator:aaf9f911fc627f3feb32fefd67a7d5344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a381427eccddbc061341642a0647eb5c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a381427eccddbc061341642a0647eb5c5">sendBufferSize</a> ()</td></tr>
<tr class="memdesc:a381427eccddbc061341642a0647eb5c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the send buffer used for the socket. <a href="classuvw_1_1Handle.html#a381427eccddbc061341642a0647eb5c5">More...</a><br /></td></tr>
<tr class="separator:a381427eccddbc061341642a0647eb5c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5101de6d8dea3bdd2bca444cde821db"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#ac5101de6d8dea3bdd2bca444cde821db">sendBufferSize</a> (int value)</td></tr>
<tr class="memdesc:ac5101de6d8dea3bdd2bca444cde821db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the size of the send buffer used for the socket. <a href="classuvw_1_1Handle.html#ac5101de6d8dea3bdd2bca444cde821db">More...</a><br /></td></tr>
<tr class="separator:ac5101de6d8dea3bdd2bca444cde821db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf07222a2587ca1eb80aec5a9af892e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#adf07222a2587ca1eb80aec5a9af892e7">recvBufferSize</a> ()</td></tr>
<tr class="memdesc:adf07222a2587ca1eb80aec5a9af892e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the receive buffer used for the socket. <a href="classuvw_1_1Handle.html#adf07222a2587ca1eb80aec5a9af892e7">More...</a><br /></td></tr>
<tr class="separator:adf07222a2587ca1eb80aec5a9af892e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a549b5f46f62b8474bad8775c6e4ff1a9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#a549b5f46f62b8474bad8775c6e4ff1a9">recvBufferSize</a> (int value)</td></tr>
<tr class="memdesc:a549b5f46f62b8474bad8775c6e4ff1a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the size of the receive buffer used for the socket. <a href="classuvw_1_1Handle.html#a549b5f46f62b8474bad8775c6e4ff1a9">More...</a><br /></td></tr>
<tr class="separator:a549b5f46f62b8474bad8775c6e4ff1a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc1994e369b89096b5a5a91a7bfc000"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceuvw.html#ad4b1016f485b28ad7dfd320a593b152b">OSFileDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Handle.html#afdc1994e369b89096b5a5a91a7bfc000">fd</a> () const</td></tr>
<tr class="memdesc:afdc1994e369b89096b5a5a91a7bfc000"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the platform dependent file descriptor equivalent. <a href="classuvw_1_1Handle.html#afdc1994e369b89096b5a5a91a7bfc000">More...</a><br /></td></tr>
<tr class="separator:afdc1994e369b89096b5a5a91a7bfc000"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classuvw_1_1Resource.html">uvw::Resource&lt; T, U &gt;</a></td></tr>
<tr class="memitem:a0d6bb9bf4bcdf98afc37d3d267178813 inherit pub_methods_classuvw_1_1Resource"><td class="memTemplParams" colspan="2">template&lt;typename R = void&gt; </td></tr>
<tr class="memitem:a0d6bb9bf4bcdf98afc37d3d267178813 inherit pub_methods_classuvw_1_1Resource"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr&lt; R &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Resource.html#a0d6bb9bf4bcdf98afc37d3d267178813">data</a> () const</td></tr>
<tr class="memdesc:a0d6bb9bf4bcdf98afc37d3d267178813 inherit pub_methods_classuvw_1_1Resource"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets user-defined data. <code>uvw</code> won't use this field in any case. <a href="classuvw_1_1Resource.html#a0d6bb9bf4bcdf98afc37d3d267178813">More...</a><br /></td></tr>
<tr class="separator:a0d6bb9bf4bcdf98afc37d3d267178813 inherit pub_methods_classuvw_1_1Resource"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f7b97267eb68d987d2f85b1161e55ee inherit pub_methods_classuvw_1_1Resource"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Resource.html#a7f7b97267eb68d987d2f85b1161e55ee">data</a> (std::shared_ptr&lt; void &gt; uData)</td></tr>
<tr class="memdesc:a7f7b97267eb68d987d2f85b1161e55ee inherit pub_methods_classuvw_1_1Resource"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets arbitrary data. <code>uvw</code> won't use this field in any case. <a href="classuvw_1_1Resource.html#a7f7b97267eb68d987d2f85b1161e55ee">More...</a><br /></td></tr>
<tr class="separator:a7f7b97267eb68d987d2f85b1161e55ee inherit pub_methods_classuvw_1_1Resource"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classuvw_1_1UnderlyingType"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classuvw_1_1UnderlyingType')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classuvw_1_1UnderlyingType.html">uvw::UnderlyingType&lt; T, U &gt;</a></td></tr>
<tr class="memitem:aab78fbfffb3c03d78aab515e605ecb18 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classuvw_1_1Loop.html">Loop</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#aab78fbfffb3c03d78aab515e605ecb18">loop</a> () const noexcept</td></tr>
<tr class="memdesc:aab78fbfffb3c03d78aab515e605ecb18 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the loop from which the resource was originated. <a href="classuvw_1_1UnderlyingType.html#aab78fbfffb3c03d78aab515e605ecb18">More...</a><br /></td></tr>
<tr class="separator:aab78fbfffb3c03d78aab515e605ecb18 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2dddf23a571afb113c8b9c5e83f056f inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memItemLeft" align="right" valign="top">const U *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#ab2dddf23a571afb113c8b9c5e83f056f">raw</a> () const noexcept</td></tr>
<tr class="memdesc:ab2dddf23a571afb113c8b9c5e83f056f inherit pub_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the underlying raw data structure. <a href="classuvw_1_1UnderlyingType.html#ab2dddf23a571afb113c8b9c5e83f056f">More...</a><br /></td></tr>
<tr class="separator:ab2dddf23a571afb113c8b9c5e83f056f inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78ac17a623e508fa410453f8c17e5970 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memItemLeft" align="right" valign="top">U *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#a78ac17a623e508fa410453f8c17e5970">raw</a> () noexcept</td></tr>
<tr class="memdesc:a78ac17a623e508fa410453f8c17e5970 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the underlying raw data structure. <a href="classuvw_1_1UnderlyingType.html#a78ac17a623e508fa410453f8c17e5970">More...</a><br /></td></tr>
<tr class="separator:a78ac17a623e508fa410453f8c17e5970 inherit pub_methods_classuvw_1_1UnderlyingType"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classuvw_1_1Emitter.html">uvw::Emitter&lt; T &gt;</a></td></tr>
<tr class="memitem:af6ba3eecb542efbef8d62ae905d8a8cd inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:af6ba3eecb542efbef8d62ae905d8a8cd inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt; E &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#af6ba3eecb542efbef8d62ae905d8a8cd">on</a> (Listener&lt; E &gt; f)</td></tr>
<tr class="memdesc:af6ba3eecb542efbef8d62ae905d8a8cd inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a long-lived listener with the event emitter. <a href="classuvw_1_1Emitter.html#af6ba3eecb542efbef8d62ae905d8a8cd">More...</a><br /></td></tr>
<tr class="separator:af6ba3eecb542efbef8d62ae905d8a8cd inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79e4ed59b5bb5cdc5ee4b0dd71a38472 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:a79e4ed59b5bb5cdc5ee4b0dd71a38472 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt; E &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a79e4ed59b5bb5cdc5ee4b0dd71a38472">once</a> (Listener&lt; E &gt; f)</td></tr>
<tr class="memdesc:a79e4ed59b5bb5cdc5ee4b0dd71a38472 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a short-lived listener with the event emitter. <a href="classuvw_1_1Emitter.html#a79e4ed59b5bb5cdc5ee4b0dd71a38472">More...</a><br /></td></tr>
<tr class="separator:a79e4ed59b5bb5cdc5ee4b0dd71a38472 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c98ab223b4367073d96c51ee3d6a0d1 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:a4c98ab223b4367073d96c51ee3d6a0d1 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a4c98ab223b4367073d96c51ee3d6a0d1">erase</a> (<a class="el" href="structuvw_1_1Emitter_1_1Connection.html">Connection</a>&lt; E &gt; conn) noexcept</td></tr>
<tr class="memdesc:a4c98ab223b4367073d96c51ee3d6a0d1 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a listener from the event emitter. <a href="classuvw_1_1Emitter.html#a4c98ab223b4367073d96c51ee3d6a0d1">More...</a><br /></td></tr>
<tr class="separator:a4c98ab223b4367073d96c51ee3d6a0d1 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d332776a2e35049549a723f35d88912 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplParams" colspan="2"><a id="a3d332776a2e35049549a723f35d88912"></a>
template&lt;typename E &gt; </td></tr>
<tr class="memitem:a3d332776a2e35049549a723f35d88912 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a3d332776a2e35049549a723f35d88912">clear</a> () noexcept</td></tr>
<tr class="memdesc:a3d332776a2e35049549a723f35d88912 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects all the listeners for the given event type. <br /></td></tr>
<tr class="separator:a3d332776a2e35049549a723f35d88912 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ff321dde35550bb40ab90a787b715cf inherit pub_methods_classuvw_1_1Emitter"><td class="memItemLeft" align="right" valign="top"><a id="a6ff321dde35550bb40ab90a787b715cf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a6ff321dde35550bb40ab90a787b715cf">clear</a> () noexcept</td></tr>
<tr class="memdesc:a6ff321dde35550bb40ab90a787b715cf inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects all the listeners. <br /></td></tr>
<tr class="separator:a6ff321dde35550bb40ab90a787b715cf inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2178cfdcc8b19baa6d7e1f950c7b65c4 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplParams" colspan="2">template&lt;typename E &gt; </td></tr>
<tr class="memitem:a2178cfdcc8b19baa6d7e1f950c7b65c4 inherit pub_methods_classuvw_1_1Emitter"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#a2178cfdcc8b19baa6d7e1f950c7b65c4">empty</a> () const noexcept</td></tr>
<tr class="memdesc:a2178cfdcc8b19baa6d7e1f950c7b65c4 inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered for the specific event. <a href="classuvw_1_1Emitter.html#a2178cfdcc8b19baa6d7e1f950c7b65c4">More...</a><br /></td></tr>
<tr class="separator:a2178cfdcc8b19baa6d7e1f950c7b65c4 inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af15516ea3df907e5e27512d05f64a1cd inherit pub_methods_classuvw_1_1Emitter"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1Emitter.html#af15516ea3df907e5e27512d05f64a1cd">empty</a> () const noexcept</td></tr>
<tr class="memdesc:af15516ea3df907e5e27512d05f64a1cd inherit pub_methods_classuvw_1_1Emitter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered with the event emitter. <a href="classuvw_1_1Emitter.html#af15516ea3df907e5e27512d05f64a1cd">More...</a><br /></td></tr>
<tr class="separator:af15516ea3df907e5e27512d05f64a1cd inherit pub_methods_classuvw_1_1Emitter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classuvw_1_1UnderlyingType"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classuvw_1_1UnderlyingType')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classuvw_1_1UnderlyingType.html">uvw::UnderlyingType&lt; T, U &gt;</a></td></tr>
<tr class="memitem:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><td class="memTemplItemLeft" align="right" valign="top">static std::shared_ptr&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1UnderlyingType.html#aa711faff7e88895f769f66e8245bda73">create</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new resource of the given type. <a href="classuvw_1_1UnderlyingType.html#aa711faff7e88895f769f66e8245bda73">More...</a><br /></td></tr>
<tr class="separator:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T, typename U&gt;<br />
class uvw::Handle&lt; T, U &gt;</h3>
<p><a class="el" href="classuvw_1_1Handle.html" title="Handle base class.">Handle</a> base class. </p>
<p>Base type for all <code>uvw</code> handle types. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00030">30</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a788704c3e891b90d28494f1ecc456803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a788704c3e891b90d28494f1ecc456803">&#9670;&nbsp;</a></span>active()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::active </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">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the handle is active. </p>
<p>What <em>active</em> means depends on the type of handle:</p>
<ul>
<li>An <a class="el" href="classuvw_1_1AsyncHandle.html" title="The AsyncHandle handle.">AsyncHandle</a> handle is always active and cannot be deactivated, except by closing it with uv_close().</li>
<li>A <a class="el" href="classuvw_1_1PipeHandle.html" title="The PipeHandle handle.">PipeHandle</a>, <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a>, <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a>, etc. handle - basically any handle that deals with I/O - is active when it is doing something that involves I/O, like reading, writing, connecting, accepting new connections, etc.</li>
<li>A <a class="el" href="classuvw_1_1CheckHandle.html" title="The CheckHandle handle.">CheckHandle</a>, <a class="el" href="classuvw_1_1IdleHandle.html" title="The IdleHandle handle.">IdleHandle</a>, <a class="el" href="classuvw_1_1TimerHandle.html" title="The TimerHandle handle.">TimerHandle</a>, etc. handle is active when it has been started with a call to <code>start()</code>.</li>
</ul>
<p>Rule of thumb: if a handle of type <code>FooHandle</code> has a <code>start()</code> member method, then it’s active from the moment that method is called. Likewise, <code>stop()</code> deactivates the handle again.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle is active, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00114">114</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a2f01819d9d8649d57841f4299f0adffa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f01819d9d8649d57841f4299f0adffa">&#9670;&nbsp;</a></span>category()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceuvw.html#aa3ae4a038de60a69b2513a039add1e48">HandleCategory</a> <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::category </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">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the category of the handle. </p>
<p>A base handle offers no functionality to promote it to the actual handle type. By means of this function, an opaque value that identifies the category of the handle is made available to the users.</p>
<dl class="section return"><dt>Returns</dt><dd>The actual category of the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00078">78</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ab6bfe6acf120b9c31c2cbe51b1151603"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6bfe6acf120b9c31c2cbe51b1151603">&#9670;&nbsp;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classuvw_1_1Request.html" title="Request base class.">Request</a> handle to be closed. </p>
<p>This <b>must</b> be called on each handle before memory is released.<br />
In-progress requests are cancelled and this can result in an <a class="el" href="structuvw_1_1ErrorEvent.html" title="The ErrorEvent event.">ErrorEvent</a> emitted.</p>
<p>The handle will emit a <a class="el" href="structuvw_1_1CloseEvent.html" title="CloseEvent event.">CloseEvent</a> when finished. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00139">139</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a150929f3f90dd31d09f5a1d0441ddf07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a150929f3f90dd31d09f5a1d0441ddf07">&#9670;&nbsp;</a></span>closing()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::closing </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">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a handle is closing or closed. </p>
<p>This function should only be used between the initialization of the handle and the arrival of the close callback.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle is closing or closed, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00126">126</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="afdc1994e369b89096b5a5a91a7bfc000"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdc1994e369b89096b5a5a91a7bfc000">&#9670;&nbsp;</a></span>fd()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceuvw.html#ad4b1016f485b28ad7dfd320a593b152b">OSFileDescriptor</a> <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::fd </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the platform dependent file descriptor equivalent. </p>
<p>Supported handles:</p>
<ul>
<li><a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a></li>
<li><a class="el" href="classuvw_1_1PipeHandle.html" title="The PipeHandle handle.">PipeHandle</a></li>
<li><a class="el" href="classuvw_1_1TTYHandle.html" title="The TTYHandle handle.">TTYHandle</a></li>
<li><a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a></li>
<li><a class="el" href="classuvw_1_1PollHandle.html" title="The PollHandle handle.">PollHandle</a></li>
</ul>
<p>It will emit an <a class="el" href="structuvw_1_1ErrorEvent.html" title="The ErrorEvent event.">ErrorEvent</a> event if invoked on any other handle.<br />
If a handle doesn’t have an attached file descriptor yet or the handle itself has been closed, an <a class="el" href="structuvw_1_1ErrorEvent.html" title="The ErrorEvent event.">ErrorEvent</a> event will be emitted.</p>
<p>See the official <a href="http://docs.libuv.org/en/v1.x/handle.html#c.uv_fileno">documentation</a> for further details.</p>
<dl class="section return"><dt>Returns</dt><dd>The file descriptor attached to the hande or a negative value in case of errors. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00267">267</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="adf07222a2587ca1eb80aec5a9af892e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf07222a2587ca1eb80aec5a9af892e7">&#9670;&nbsp;</a></span>recvBufferSize() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::recvBufferSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the size of the receive buffer used for the socket. </p>
<p>Gets the size of the receive buffer that the operating system uses for the socket.<br />
This function works for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a>, <a class="el" href="classuvw_1_1PipeHandle.html" title="The PipeHandle handle.">PipeHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Unix and for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Windows.<br />
Note that Linux will return double the size of the original set value.</p>
<dl class="section return"><dt>Returns</dt><dd>The size of the receive buffer, 0 in case of errors. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00224">224</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a549b5f46f62b8474bad8775c6e4ff1a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a549b5f46f62b8474bad8775c6e4ff1a9">&#9670;&nbsp;</a></span>recvBufferSize() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::recvBufferSize </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the size of the receive buffer used for the socket. </p>
<p>Sets the size of the receive buffer that the operating system uses for the socket.<br />
This function works for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a>, <a class="el" href="classuvw_1_1PipeHandle.html" title="The PipeHandle handle.">PipeHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Unix and for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Windows.<br />
Note that Linux will set double the size.</p>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00241">241</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a2d7c8e8229d6e1680c6b6f337ecfcfc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d7c8e8229d6e1680c6b6f337ecfcfc7">&#9670;&nbsp;</a></span>reference()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::reference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reference the given handle. </p>
<p>References are idempotent, that is, if a handle is already referenced calling this function again will have no effect. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00151">151</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="aeccf6a30e939c34c5370b5abfeb49e34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeccf6a30e939c34c5370b5abfeb49e34">&#9670;&nbsp;</a></span>referenced()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::referenced </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">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the given handle referenced. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle referenced, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00169">169</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a381427eccddbc061341642a0647eb5c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a381427eccddbc061341642a0647eb5c5">&#9670;&nbsp;</a></span>sendBufferSize() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::sendBufferSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the size of the send buffer used for the socket. </p>
<p>Gets the size of the send buffer that the operating system uses for the socket.<br />
This function works for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a>, <a class="el" href="classuvw_1_1PipeHandle.html" title="The PipeHandle handle.">PipeHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Unix and for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Windows.<br />
Note that Linux will return double the size of the original set value.</p>
<dl class="section return"><dt>Returns</dt><dd>The size of the send buffer, 0 in case of errors. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00192">192</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ac5101de6d8dea3bdd2bca444cde821db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5101de6d8dea3bdd2bca444cde821db">&#9670;&nbsp;</a></span>sendBufferSize() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::sendBufferSize </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the size of the send buffer used for the socket. </p>
<p>Sets the size of the send buffer that the operating system uses for the socket.<br />
This function works for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a>, <a class="el" href="classuvw_1_1PipeHandle.html" title="The PipeHandle handle.">PipeHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Unix and for <a class="el" href="classuvw_1_1TCPHandle.html" title="The TCPHandle handle.">TCPHandle</a> and <a class="el" href="classuvw_1_1UDPHandle.html" title="The UDPHandle handle.">UDPHandle</a> handles on Windows.<br />
Note that Linux will set double the size.</p>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00209">209</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="aaf9f911fc627f3feb32fefd67a7d5344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf9f911fc627f3feb32fefd67a7d5344">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::size_t <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::size </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">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size of the underlying handle type. </p>
<dl class="section return"><dt>Returns</dt><dd>The size of the underlying handle type. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00177">177</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a5ab7b63ff4b7be5ba3fc48dc7e094530"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ab7b63ff4b7be5ba3fc48dc7e094530">&#9670;&nbsp;</a></span>type()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceuvw.html#ad8b4c4aaf16bbe0b08218b42fbf32f0e">HandleType</a> <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::type </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">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the type of the handle. </p>
<p>A base handle offers no functionality to promote it to the actual handle type. By means of this function, the type of the underlying handle as specified by HandleType is made available to the users.</p>
<dl class="section return"><dt>Returns</dt><dd>The actual type of the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00091">91</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a7d1df5f35276ab9c2a3696ef7b2e1761"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d1df5f35276ab9c2a3696ef7b2e1761">&#9670;&nbsp;</a></span>unreference()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classuvw_1_1Handle.html">uvw::Handle</a>&lt; T, U &gt;::unreference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unreference the given handle. </p>
<p>References are idempotent, that is, if a handle is not referenced calling this function again will have no effect. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00161">161</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/uvw/<a class="el" href="handle_8hpp_source.html">handle.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink