uvw/resource_8hpp_source.html
2023-05-22 11:13:58 +02:00

146 lines
14 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: src/uvw/resource.hpp Source File</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">&#160;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&amp;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&amp;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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_98934c98f70735fe3a272005a9eb8736.html">uvw</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">resource.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef UVW_RESOURCE_INCLUDE_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_RESOURCE_INCLUDE_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;config.h&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;emitter.h&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;uv_type.hpp&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, <span class="keyword">typename</span>... E&gt;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classuvw_1_1resource.html"> 18</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1resource.html">resource</a>: <span class="keyword">public</span> <a class="code hl_struct" href="structuvw_1_1uv__type.html">uv_type</a>&lt;U&gt;, <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1emitter.html">emitter</a>&lt;T, E...&gt;, <span class="keyword">public</span> std::enable_shared_from_this&lt;T&gt; {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordtype">int</span> leak_if(<span class="keywordtype">int</span> err) <span class="keyword">noexcept</span> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordflow">if</span>(err == 0) {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> self_ptr = this-&gt;shared_from_this();</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> }</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordflow">return</span> err;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> }</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> self_reset() <span class="keyword">noexcept</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> self_ptr.reset();</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">bool</span> has_self() <span class="keyword">const</span> <span class="keyword">noexcept</span> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">bool</span><span class="keyword">&gt;</span>(self_ptr);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classuvw_1_1resource.html">resource</a>(loop::token token, std::shared_ptr&lt;loop&gt; ref)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> : <a class="code hl_struct" href="structuvw_1_1uv__type.html">uv_type&lt;U&gt;</a>{token, std::move(ref)} {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> this-&gt;<a class="code hl_function" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a>()-&gt;data = <span class="keyword">this</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> R = <span class="keywordtype">void</span>&gt;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classuvw_1_1resource.html#a7c05e988ebaa14d1dbbc781951dc3a88"> 47</a></span> std::shared_ptr&lt;R&gt; <a class="code hl_function" href="classuvw_1_1resource.html#a7c05e988ebaa14d1dbbc781951dc3a88">data</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">return</span> std::static_pointer_cast&lt;R&gt;(user_data);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classuvw_1_1resource.html#a759079eb405e5d2fda795d199d8efa80"> 55</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classuvw_1_1resource.html#a759079eb405e5d2fda795d199d8efa80">data</a>(std::shared_ptr&lt;void&gt; udata) {</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> user_data = std::move(udata);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> }</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> std::shared_ptr&lt;void&gt; user_data{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> std::shared_ptr&lt;void&gt; self_ptr{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>};</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>} <span class="comment">// namespace uvw</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#endif </span><span class="comment">// UVW_RESOURCE_INCLUDE_H</span></div>
<div class="ttc" id="aclassuvw_1_1emitter_html"><div class="ttname"><a href="classuvw_1_1emitter.html">uvw::emitter</a></div><div class="ttdoc">Event emitter base class.</div><div class="ttdef"><b>Definition:</b> <a href="emitter_8h_source.html#l00083">emitter.h:83</a></div></div>
<div class="ttc" id="aclassuvw_1_1resource_html"><div class="ttname"><a href="classuvw_1_1resource.html">uvw::resource</a></div><div class="ttdoc">Common class for almost all the resources available in uvw.</div><div class="ttdef"><b>Definition:</b> <a href="resource_8hpp_source.html#l00018">resource.hpp:18</a></div></div>
<div class="ttc" id="aclassuvw_1_1resource_html_a759079eb405e5d2fda795d199d8efa80"><div class="ttname"><a href="classuvw_1_1resource.html#a759079eb405e5d2fda795d199d8efa80">uvw::resource::data</a></div><div class="ttdeci">void data(std::shared_ptr&lt; void &gt; udata)</div><div class="ttdoc">Sets arbitrary data. uvw won't use this field in any case.</div><div class="ttdef"><b>Definition:</b> <a href="resource_8hpp_source.html#l00055">resource.hpp:55</a></div></div>
<div class="ttc" id="aclassuvw_1_1resource_html_a7c05e988ebaa14d1dbbc781951dc3a88"><div class="ttname"><a href="classuvw_1_1resource.html#a7c05e988ebaa14d1dbbc781951dc3a88">uvw::resource::data</a></div><div class="ttdeci">std::shared_ptr&lt; R &gt; data() const</div><div class="ttdoc">Gets user-defined data. uvw won't use this field in any case.</div><div class="ttdef"><b>Definition:</b> <a href="resource_8hpp_source.html#l00047">resource.hpp:47</a></div></div>
<div class="ttc" id="anamespaceuvw_html"><div class="ttname"><a href="namespaceuvw.html">uvw</a></div><div class="ttdoc">uvw default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="async_8h_source.html#l00008">async.h:8</a></div></div>
<div class="ttc" id="astructuvw_1_1uv__type_html"><div class="ttname"><a href="structuvw_1_1uv__type.html">uvw::uv_type</a></div><div class="ttdoc">Wrapper class for underlying types.</div><div class="ttdef"><b>Definition:</b> <a href="uv__type_8hpp_source.html#l00018">uv_type.hpp:18</a></div></div>
<div class="ttc" id="astructuvw_1_1uv__type_html_a06a6cb7ebde27aa348e340b76e49c6ae"><div class="ttname"><a href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">uvw::uv_type::raw</a></div><div class="ttdeci">const U * raw() const noexcept</div><div class="ttdoc">Gets the underlying raw data structure.</div><div class="ttdef"><b>Definition:</b> <a href="uv__type_8hpp_source.html#l00059">uv_type.hpp:59</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>