Files
moslab-code/doc/source/html/util_2unique__cap_source.html
2025-09-12 15:55:45 +02:00

162 lines
16 KiB
HTML

<!-- HTML header for doxygen 1.9.1-->
<!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.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>L4Re Operating System Framework: l4/re/util/unique_cap 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="l4re-awesome.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="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">L4Re Operating System Framework
</div>
<div id="projectbrief">Interface and Usage Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</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',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('util_2unique__cap_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">unique_cap</div></div>
</div><!--header-->
<div class="contents">
<a href="util_2unique__cap.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// vim:set ft=cpp: -*- Mode: C++ -*-</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">/*</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * (c) 2017 Alexander Warg &lt;alexander.warg@kernkonzept.com&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> */</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;<a class="code" href="util_2cap__alloc.html">l4/re/util/cap_alloc</a>&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &lt;<a class="code" href="smart__capability__1x.html">l4/sys/cxx/smart_capability_1x</a>&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4Re.html">L4Re</a> { <span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4Re_1_1Util.html">Util</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">template</span>&lt; <span class="keyword">typename</span> T &gt;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="namespaceL4Re_1_1Util.html#a0efccd325a19246334922e58dd973914"> 43</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a0efccd325a19246334922e58dd973914">Unique_cap</a> = L4::Detail::Unique_cap_impl&lt;T, Smart_cap_auto&lt;L4_FP_ALL_SPACES&gt;&gt;;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keyword">template</span>&lt; <span class="keyword">typename</span> T &gt;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="namespaceL4Re_1_1Util.html#a987984b0219186ceb761fb221e705557"> 46</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a987984b0219186ceb761fb221e705557">unique_cap</a> = L4::Detail::Unique_cap_impl&lt;T, Smart_cap_auto&lt;L4_FP_ALL_SPACES&gt;&gt;;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">template</span>&lt; <span class="keyword">typename</span> T &gt;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a0efccd325a19246334922e58dd973914">Unique_cap&lt;T&gt;</a></div>
<div class="foldopen" id="foldopen00055" data-start="{" data-end="}">
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="namespaceL4Re_1_1Util.html#a0c4ee77222764600950f2ebe23a1e45a"> 55</a></span><a class="code hl_function" href="namespaceL4Re_1_1Util.html#a0c4ee77222764600950f2ebe23a1e45a">make_unique_cap</a>()</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>{ <span class="keywordflow">return</span> <a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a0efccd325a19246334922e58dd973914">Unique_cap&lt;T&gt;</a>(<a class="code hl_variable" href="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</a>.alloc&lt;T&gt;()); }</div>
</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keyword">template</span>&lt; <span class="keyword">typename</span> T &gt;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="namespaceL4Re_1_1Util.html#a13a4df2df2fdffc06880b49fb10b0c74"> 86</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a13a4df2df2fdffc06880b49fb10b0c74">Unique_del_cap</a> = L4::Detail::Unique_cap_impl&lt;T, Smart_cap_auto&lt;L4_FP_DELETE_OBJ&gt;&gt;;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="keyword">template</span>&lt; <span class="keyword">typename</span> T &gt;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="namespaceL4Re_1_1Util.html#a9cdcf86bc007bba92b86b66fa92a00bf"> 89</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a9cdcf86bc007bba92b86b66fa92a00bf">unique_del_cap</a> = L4::Detail::Unique_cap_impl&lt;T, Smart_cap_auto&lt;L4_FP_DELETE_OBJ&gt;&gt;;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="keyword">template</span>&lt; <span class="keyword">typename</span> T &gt;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a13a4df2df2fdffc06880b49fb10b0c74">Unique_del_cap&lt;T&gt;</a></div>
<div class="foldopen" id="foldopen00098" data-start="{" data-end="}">
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="namespaceL4Re_1_1Util.html#a4c9140864b109e2582d94d5def245fd1"> 98</a></span><a class="code hl_function" href="namespaceL4Re_1_1Util.html#a4c9140864b109e2582d94d5def245fd1">make_unique_del_cap</a>()</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>{ <span class="keywordflow">return</span> <a class="code hl_typedef" href="namespaceL4Re_1_1Util.html#a13a4df2df2fdffc06880b49fb10b0c74">Unique_del_cap&lt;T&gt;</a>(<a class="code hl_variable" href="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">cap_alloc</a>.alloc&lt;T&gt;()); }</div>
</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>}}</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="ttc" id="agroup__l4re__cap__api_html_ga29e3dbeb3c8ed0609519c9df212c9c52"><div class="ttname"><a href="group__l4re__cap__api.html#ga29e3dbeb3c8ed0609519c9df212c9c52">L4Re::Util::cap_alloc</a></div><div class="ttdeci">_Cap_alloc &amp; cap_alloc</div><div class="ttdoc">Capability allocator.</div></div>
<div class="ttc" id="anamespaceL4Re_1_1Util_html"><div class="ttname"><a href="namespaceL4Re_1_1Util.html">L4Re::Util</a></div><div class="ttdoc">Documentation of the L4 Runtime Environment utility functionality in C++.</div><div class="ttdef"><b>Definition</b> <a href="pkg_2l4re-core_2l4re_2doc_2l4re_8dox_source.html#l00021">l4re.dox:21</a></div></div>
<div class="ttc" id="anamespaceL4Re_1_1Util_html_a0c4ee77222764600950f2ebe23a1e45a"><div class="ttname"><a href="namespaceL4Re_1_1Util.html#a0c4ee77222764600950f2ebe23a1e45a">L4Re::Util::make_unique_cap</a></div><div class="ttdeci">Unique_cap&lt; T &gt; make_unique_cap()</div><div class="ttdoc">Allocate a capability slot and wrap it in an Unique_cap.</div><div class="ttdef"><b>Definition</b> <a href="#l00055">unique_cap:55</a></div></div>
<div class="ttc" id="anamespaceL4Re_1_1Util_html_a0efccd325a19246334922e58dd973914"><div class="ttname"><a href="namespaceL4Re_1_1Util.html#a0efccd325a19246334922e58dd973914">L4Re::Util::Unique_cap</a></div><div class="ttdeci">L4::Detail::Unique_cap_impl&lt; T, Smart_cap_auto&lt; L4_FP_ALL_SPACES &gt; &gt; Unique_cap</div><div class="ttdoc">Unique capability that implements automatic free and unmap of the capability selector.</div><div class="ttdef"><b>Definition</b> <a href="#l00043">unique_cap:43</a></div></div>
<div class="ttc" id="anamespaceL4Re_1_1Util_html_a13a4df2df2fdffc06880b49fb10b0c74"><div class="ttname"><a href="namespaceL4Re_1_1Util.html#a13a4df2df2fdffc06880b49fb10b0c74">L4Re::Util::Unique_del_cap</a></div><div class="ttdeci">L4::Detail::Unique_cap_impl&lt; T, Smart_cap_auto&lt; L4_FP_DELETE_OBJ &gt; &gt; Unique_del_cap</div><div class="ttdoc">Unique capability that implements automatic free and unmap+delete of the capability selector.</div><div class="ttdef"><b>Definition</b> <a href="#l00086">unique_cap:86</a></div></div>
<div class="ttc" id="anamespaceL4Re_1_1Util_html_a4c9140864b109e2582d94d5def245fd1"><div class="ttname"><a href="namespaceL4Re_1_1Util.html#a4c9140864b109e2582d94d5def245fd1">L4Re::Util::make_unique_del_cap</a></div><div class="ttdeci">Unique_del_cap&lt; T &gt; make_unique_del_cap()</div><div class="ttdoc">Allocate a capability slot and wrap it in an Unique_del_cap.</div><div class="ttdef"><b>Definition</b> <a href="#l00098">unique_cap:98</a></div></div>
<div class="ttc" id="anamespaceL4Re_1_1Util_html_a987984b0219186ceb761fb221e705557"><div class="ttname"><a href="namespaceL4Re_1_1Util.html#a987984b0219186ceb761fb221e705557">L4Re::Util::unique_cap</a></div><div class="ttdeci">L4::Detail::Unique_cap_impl&lt; T, Smart_cap_auto&lt; L4_FP_ALL_SPACES &gt; &gt; unique_cap</div><div class="ttdoc">Unique capability that implements automatic free and unmap of the capability selector.</div><div class="ttdef"><b>Definition</b> <a href="#l00046">unique_cap:46</a></div></div>
<div class="ttc" id="anamespaceL4Re_1_1Util_html_a9cdcf86bc007bba92b86b66fa92a00bf"><div class="ttname"><a href="namespaceL4Re_1_1Util.html#a9cdcf86bc007bba92b86b66fa92a00bf">L4Re::Util::unique_del_cap</a></div><div class="ttdeci">L4::Detail::Unique_cap_impl&lt; T, Smart_cap_auto&lt; L4_FP_DELETE_OBJ &gt; &gt; unique_del_cap</div><div class="ttdoc">Unique capability that implements automatic free and unmap+delete of the capability selector.</div><div class="ttdef"><b>Definition</b> <a href="#l00089">unique_cap:89</a></div></div>
<div class="ttc" id="anamespaceL4Re_html"><div class="ttname"><a href="namespaceL4Re.html">L4Re</a></div><div class="ttdoc">L4Re C++ Interfaces.</div><div class="ttdef"><b>Definition</b> <a href="cmd__control_source.html#l00014">cmd_control:14</a></div></div>
<div class="ttc" id="asmart__capability__1x_html"><div class="ttname"><a href="smart__capability__1x.html">smart_capability_1x</a></div></div>
<div class="ttc" id="autil_2cap__alloc_html"><div class="ttname"><a href="util_2cap__alloc.html">cap_alloc</a></div><div class="ttdoc">Capability allocator.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>l4</b></li><li class="navelem"><b>re</b></li><li class="navelem"><b>util</b></li><li class="navelem"><a href="util_2unique__cap.html">unique_cap</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
</ul>
</div>
</body>
</html>