156 lines
13 KiB
HTML
156 lines
13 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/cxx/ipc_helper 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('ipc__helper_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">ipc_helper</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ipc__helper.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">// vi: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) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * Alexander Warg <warg@os.inf.tu-dresden.de></span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * economic rights: Technische Universität Dresden (Germany)</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><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include <<a class="code" href="exceptions.html">l4/cxx/exceptions</a>></span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include <<a class="code" href="l4_2sys_2utcb_8h.html">l4/sys/utcb.h</a>></span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4.html">L4</a></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><span class="preprocessor">#ifdef __EXCEPTIONS</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">inline</span> <span class="keywordtype">void</span></div>
|
|
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="group__helper.html#gaba0849c4b92afdccbe110489e18dadbd"> 34</a></span> <a class="code hl_function" href="group__helper.html#gaba0849c4b92afdccbe110489e18dadbd">throw_ipc_exception</a>([[maybe_unused]] <a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap<void></a> <span class="keyword">const</span> &o,</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_struct" href="structl4__msgtag__t.html">l4_msgtag_t</a> <span class="keyword">const</span> &err, <a class="code hl_typedef" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb)</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">if</span> (err.<a class="code hl_function" href="structl4__msgtag__t.html#a433eb16b19202d09cc98b40a139b3c29">has_error</a>())</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">throw</span> (<a class="code hl_class" href="classL4_1_1Com__error.html">L4::Com_error</a>(l4_error_u(err, utcb)));</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">inline</span> <span class="keywordtype">void</span></div>
|
|
<div class="foldopen" id="foldopen00050" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="group__helper.html#ga54f8da0e02ff2496f1ad935e38ab17c4"> 50</a></span> <a class="code hl_function" href="group__helper.html#gaba0849c4b92afdccbe110489e18dadbd">throw_ipc_exception</a>(<span class="keywordtype">void</span> <span class="keyword">const</span> *o, <a class="code hl_struct" href="structl4__msgtag__t.html">l4_msgtag_t</a> <span class="keyword">const</span> &err,</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_typedef" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb)</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> { <a class="code hl_function" href="group__helper.html#gaba0849c4b92afdccbe110489e18dadbd">throw_ipc_exception</a>(<a class="code hl_class" href="classL4_1_1Cap.html">L4::Cap<void></a>(o), err, utcb); }</div>
|
|
</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>}</div>
|
|
<div class="ttc" id="aclassL4_1_1Cap_html"><div class="ttname"><a href="classL4_1_1Cap.html">L4::Cap</a></div><div class="ttdoc">C++ interface for capabilities.</div><div class="ttdef"><b>Definition</b> <a href="capability_8h_source.html#l00223">capability.h:224</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Com__error_html"><div class="ttname"><a href="classL4_1_1Com__error.html">L4::Com_error</a></div><div class="ttdoc">Error conditions during IPC.</div><div class="ttdef"><b>Definition</b> <a href="exceptions_source.html#l00263">exceptions:264</a></div></div>
|
|
<div class="ttc" id="aexceptions_html"><div class="ttname"><a href="exceptions.html">exceptions</a></div><div class="ttdoc">Base exceptions.</div></div>
|
|
<div class="ttc" id="agroup__helper_html_gaba0849c4b92afdccbe110489e18dadbd"><div class="ttname"><a href="group__helper.html#gaba0849c4b92afdccbe110489e18dadbd">L4::throw_ipc_exception</a></div><div class="ttdeci">void throw_ipc_exception(L4::Cap< void > const &o, l4_msgtag_t const &err, l4_utcb_t *utcb)</div><div class="ttdoc">Throw an L4 IPC error as exception.</div><div class="ttdef"><b>Definition</b> <a href="#l00034">ipc_helper:34</a></div></div>
|
|
<div class="ttc" id="agroup__l4__utcb__api_html_ga89be8a86d11c1d532b636cc2df1330fb"><div class="ttname"><a href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a></div><div class="ttdeci">struct l4_utcb_t l4_utcb_t</div><div class="ttdoc">Opaque type for the UTCB.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2utcb_8h_source.html#l00056">utcb.h:56</a></div></div>
|
|
<div class="ttc" id="al4_2sys_2utcb_8h_html"><div class="ttname"><a href="l4_2sys_2utcb_8h.html">utcb.h</a></div><div class="ttdoc">UTCB definitions.</div></div>
|
|
<div class="ttc" id="anamespaceL4_html"><div class="ttname"><a href="namespaceL4.html">L4</a></div><div class="ttdoc">L4 low-level kernel interface.</div><div class="ttdef"><b>Definition</b> <a href="l4sys-l4f-groups_8dox_source.html#l00050">l4sys-l4f-groups.dox:50</a></div></div>
|
|
<div class="ttc" id="astructl4__msgtag__t_html"><div class="ttname"><a href="structl4__msgtag__t.html">l4_msgtag_t</a></div><div class="ttdoc">Message tag data structure.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2types_8h_source.html#l00153">types.h:154</a></div></div>
|
|
<div class="ttc" id="astructl4__msgtag__t_html_a433eb16b19202d09cc98b40a139b3c29"><div class="ttname"><a href="structl4__msgtag__t.html#a433eb16b19202d09cc98b40a139b3c29">l4_msgtag_t::has_error</a></div><div class="ttdeci">bool has_error() const L4_NOTHROW</div><div class="ttdoc">Test if flags indicate an error.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2types_8h_source.html#l00191">types.h:191</a></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>cxx</b></li><li class="navelem"><a href="ipc__helper.html">ipc_helper</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>
|