luo980/uvw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
91d6479222
uvw/classuvw_1_1SharedLib.html
Michele Caini 91d6479222 api reference
2017-10-11 09:11:53 +02:00

238 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: uvw::SharedLib 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uvw
&#160;<span id="projectnumber">1.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_1SharedLib.html">SharedLib</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_1SharedLib-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uvw::SharedLib Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classuvw_1_1SharedLib.html" title="The SharedLib class. ">SharedLib</a> class.
<a href="classuvw_1_1SharedLib.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="lib_8hpp_source.html">lib.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for uvw::SharedLib:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1SharedLib__inherit__graph.png" border="0" usemap="#uvw_1_1SharedLib_inherit__map" alt="Inheritance graph"/></div>
<map name="uvw_1_1SharedLib_inherit__map" id="uvw_1_1SharedLib_inherit__map">
<area shape="rect" id="node2" href="classuvw_1_1UnderlyingType.html" title="uvw::UnderlyingType\l\&lt; SharedLib, uv_lib_t \&gt;" alt="" coords="5,5,163,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for uvw::SharedLib:</div>
<div class="dyncontent">
<div class="center"><img src="classuvw_1_1SharedLib__coll__graph.png" border="0" usemap="#uvw_1_1SharedLib_coll__map" alt="Collaboration graph"/></div>
<map name="uvw_1_1SharedLib_coll__map" id="uvw_1_1SharedLib_coll__map">
<area shape="rect" id="node2" href="classuvw_1_1UnderlyingType.html" title="uvw::UnderlyingType\l\&lt; SharedLib, uv_lib_t \&gt;" alt="" coords="5,5,163,47"/>
</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:a709aa1a5fabce70e1c29e5ee541ab04f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1SharedLib.html#a709aa1a5fabce70e1c29e5ee541ab04f">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a709aa1a5fabce70e1c29e5ee541ab04f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the library has been correctly opened. <a href="#a709aa1a5fabce70e1c29e5ee541ab04f">More...</a><br /></td></tr>
<tr class="separator:a709aa1a5fabce70e1c29e5ee541ab04f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a632464f5e192547abe462c0d04b9f8a3"><td class="memTemplParams" colspan="2">template&lt;typename F &gt; </td></tr>
<tr class="memitem:a632464f5e192547abe462c0d04b9f8a3"><td class="memTemplItemLeft" align="right" valign="top">F *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuvw_1_1SharedLib.html#a632464f5e192547abe462c0d04b9f8a3">sym</a> (std::string name)</td></tr>
<tr class="memdesc:a632464f5e192547abe462c0d04b9f8a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a data pointer from a dynamic library. <a href="#a632464f5e192547abe462c0d04b9f8a3">More...</a><br /></td></tr>
<tr class="separator:a632464f5e192547abe462c0d04b9f8a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeebf1af0f31f12c2900ce7d1e0bc761"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuvw_1_1SharedLib.html#abeebf1af0f31f12c2900ce7d1e0bc761">error</a> () const noexcept</td></tr>
<tr class="memdesc:abeebf1af0f31f12c2900ce7d1e0bc761"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last error message, if any. <a href="#abeebf1af0f31f12c2900ce7d1e0bc761">More...</a><br /></td></tr>
<tr class="separator:abeebf1af0f31f12c2900ce7d1e0bc761"><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; SharedLib, uv_lib_t &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>
</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; SharedLib, uv_lib_t &gt;</a></td></tr>
<tr class="memitem:aa711faff7e88895f769f66e8245bda73 inherit pub_static_methods_classuvw_1_1UnderlyingType"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="classuvw_1_1SharedLib.html">SharedLib</a> &gt;&#160;</td><td class="memItemRight" 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"><p>The <a class="el" href="classuvw_1_1SharedLib.html" title="The SharedLib class. ">SharedLib</a> class. </p>
<p><code>uvw</code> provides cross platform utilities for loading shared libraries and retrieving symbols from them, by means of the API offered by <code>libuv</code>. </p>
<p class="definition">Definition at line <a class="el" href="lib_8hpp_source.html#l00022">22</a> of file <a class="el" href="lib_8hpp_source.html">lib.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abeebf1af0f31f12c2900ce7d1e0bc761"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeebf1af0f31f12c2900ce7d1e0bc761">&#9670;&nbsp;</a></span>error()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* uvw::SharedLib::error </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 last error message, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>The last error message, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="lib_8hpp_source.html#l00062">62</a> of file <a class="el" href="lib_8hpp_source.html">lib.hpp</a>.</p>
</div>
</div>
<a id="a709aa1a5fabce70e1c29e5ee541ab04f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a709aa1a5fabce70e1c29e5ee541ab04f">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uvw::SharedLib::operator bool </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">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the library has been correctly opened. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the library is opened, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="lib_8hpp_source.html#l00038">38</a> of file <a class="el" href="lib_8hpp_source.html">lib.hpp</a>.</p>
</div>
</div>
<a id="a632464f5e192547abe462c0d04b9f8a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a632464f5e192547abe462c0d04b9f8a3">&#9670;&nbsp;</a></span>sym()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename F &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">F* uvw::SharedLib::sym </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>name</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>Retrieves a data pointer from a dynamic library. </p>
<p><code>F</code> shall be a valid function type (as an example, <code>void(int)</code>).<br />
It is legal for a symbol to map to <code>nullptr</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The symbol to be retrieved. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid function pointer in case of success, <code>nullptr</code> otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="lib_8hpp_source.html#l00050">50</a> of file <a class="el" href="lib_8hpp_source.html">lib.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="lib_8hpp_source.html">lib.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.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink