teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

l4re-base-25.08.0

Browse Source
This commit is contained in:
Viktor Reusch
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

404
doc/source/html/structL4_1_1Epiface.html Normal file
View File

@@ -0,0 +1,404 @@
<!-- 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::Epiface Struct 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="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('structL4_1_1Epiface.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">L4::Epiface Struct Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for interface implementations.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ipc__epiface_source.html">ipc_epiface</a>&gt;</code></p>
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for L4::Epiface:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="structL4_1_1Epiface__inherit__graph.svg" width="3080" height="1560"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for L4::Epiface:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="structL4_1_1Epiface__coll__graph.svg" width="176" height="216"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-types" class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aeec53d54ab6eb8e660679cdda1102fd7" id="r_aeec53d54ab6eb8e660679cdda1102fd7"><td class="memItemLeft" align="right" valign="top"><a id="aeec53d54ab6eb8e660679cdda1102fd7" name="aeec53d54ab6eb8e660679cdda1102fd7"></a>
typedef <a class="el" href="classL4_1_1Ipc__svr_1_1Server__iface.html">Ipc_svr::Server_iface</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Server_iface</b></td></tr>
<tr class="memdesc:aeec53d54ab6eb8e660679cdda1102fd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for abstract server interface. <br /></td></tr>
<tr class="memitem:a3b6915f6a99478aa323219cb5441cd24" id="r_a3b6915f6a99478aa323219cb5441cd24"><td class="memItemLeft" align="right" valign="top"><a id="a3b6915f6a99478aa323219cb5441cd24" name="a3b6915f6a99478aa323219cb5441cd24"></a>
typedef <a class="el" href="classL4_1_1Ipc__svr_1_1Server__iface.html#a06e47dba2ba71662337758f0cbf37053">Ipc_svr::Server_iface::Demand</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Demand</b></td></tr>
<tr class="memdesc:a3b6915f6a99478aa323219cb5441cd24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for server-side receive buffer demand. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afadfe87d66e639d554b6a4e5af29454d" id="r_afadfe87d66e639d554b6a4e5af29454d"><td class="memItemLeft" align="right" valign="top"><a id="afadfe87d66e639d554b6a4e5af29454d" name="afadfe87d66e639d554b6a4e5af29454d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Epiface</b> ()</td></tr>
<tr class="memdesc:afadfe87d66e639d554b6a4e5af29454d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make a server object. <br /></td></tr>
<tr class="memitem:aa77168d1ca477f5f7e72c4535f143381" id="r_aa77168d1ca477f5f7e72c4535f143381"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa77168d1ca477f5f7e72c4535f143381">dispatch</a> (<a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a> tag, unsigned rights, <a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *utcb)=0</td></tr>
<tr class="memdesc:aa77168d1ca477f5f7e72c4535f143381"><td class="mdescLeft">&#160;</td><td class="mdescRight">The abstract handler for client requests to the object. <br /></td></tr>
<tr class="memitem:ade91f9c2edbdec88a1d1c9a6cf43a533" id="r_ade91f9c2edbdec88a1d1c9a6cf43a533"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="#a3b6915f6a99478aa323219cb5441cd24">Demand</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ade91f9c2edbdec88a1d1c9a6cf43a533">get_buffer_demand</a> () const =0</td></tr>
<tr class="memdesc:ade91f9c2edbdec88a1d1c9a6cf43a533"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the server-side receive buffer demand for this object. <br /></td></tr>
<tr class="memitem:a92a03ecd44d4e1571697b58701046522" id="r_a92a03ecd44d4e1571697b58701046522"><td class="memItemLeft" align="right" valign="top"><a id="a92a03ecd44d4e1571697b58701046522" name="a92a03ecd44d4e1571697b58701046522"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~Epiface</b> ()=0</td></tr>
<tr class="memdesc:a92a03ecd44d4e1571697b58701046522"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the object. <br /></td></tr>
<tr class="memitem:a0d454b9446bdf9e317b09574a5155fe0" id="r_a0d454b9446bdf9e317b09574a5155fe0"><td class="memItemLeft" align="right" valign="top">Stored_cap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d454b9446bdf9e317b09574a5155fe0">obj_cap</a> () const</td></tr>
<tr class="memdesc:a0d454b9446bdf9e317b09574a5155fe0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the capability to the kernel object belonging to this object. <br /></td></tr>
<tr class="memitem:a9605834c855375364504bd0f7ae78273" id="r_a9605834c855375364504bd0f7ae78273"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#aeec53d54ab6eb8e660679cdda1102fd7">Server_iface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9605834c855375364504bd0f7ae78273">server_iface</a> () const</td></tr>
<tr class="memdesc:a9605834c855375364504bd0f7ae78273"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get pointer to server interface at which the object is currently registered. <br /></td></tr>
<tr class="memitem:af47d6b2877fa4a09e04140a6644631aa" id="r_af47d6b2877fa4a09e04140a6644631aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af47d6b2877fa4a09e04140a6644631aa">set_server</a> (<a class="el" href="#aeec53d54ab6eb8e660679cdda1102fd7">Server_iface</a> *srv, <a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; void &gt; cap, bool managed=false)</td></tr>
<tr class="memdesc:af47d6b2877fa4a09e04140a6644631aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set server registration info for the object. <br /></td></tr>
<tr class="memitem:ab7308b8ad45d0a6341c351797c3d6dbd" id="r_ab7308b8ad45d0a6341c351797c3d6dbd"><td class="memItemLeft" align="right" valign="top"><a id="ab7308b8ad45d0a6341c351797c3d6dbd" name="ab7308b8ad45d0a6341c351797c3d6dbd"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_obj_cap</b> (<a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; void &gt; const &amp;cap)</td></tr>
<tr class="memdesc:ab7308b8ad45d0a6341c351797c3d6dbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated server registration function. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for interface implementations. </p>
<p>An <a class="el" href="structL4_1_1Epiface.html" title="Base class for interface implementations.">Epiface</a> is the base interface of objects registered in the server loop. Incomming IPC gets dispatched to the appropriate <a class="el" href="structL4_1_1Epiface.html" title="Base class for interface implementations.">Epiface</a> object where the call is then handled appropriately.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="classL4_1_1Server.html" title="Basic server loop for handling client requests.">Server</a> loops are allowed to internally keep raw pointers to <a class="el" href="structL4_1_1Epiface.html" title="Base class for interface implementations.">Epiface</a> objects for dispatching calls. Instances must therefore never be copied or moved. </dd></dl>
<p class="definition">Definition at line <a class="el" href="ipc__epiface_source.html#l00145">145</a> of file <a class="el" href="ipc__epiface_source.html">ipc_epiface</a>.</p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="aa77168d1ca477f5f7e72c4535f143381" name="aa77168d1ca477f5f7e72c4535f143381"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa77168d1ca477f5f7e72c4535f143381">&#9670;&#160;</a></span>dispatch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a> L4::Epiface::dispatch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structl4__msgtag__t.html">l4_msgtag_t</a></td> <td class="paramname"><span class="paramname"><em>tag</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>rights</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__l4__utcb__api.html#ga89be8a86d11c1d532b636cc2df1330fb">l4_utcb_t</a> *</td> <td class="paramname"><span class="paramname"><em>utcb</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The abstract handler for client requests to the object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>The message tag for this invocation. </td></tr>
<tr><td class="paramname">rights</td><td>The rights bits in the invoked capability. </td></tr>
<tr><td class="paramname">utcb</td><td>The UTCB used for the invocation. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">-L4_ENOREPLY</td><td>No reply message is send. </td></tr>
<tr><td class="paramname">&lt;0</td><td>Error, reply with error code. </td></tr>
<tr><td class="paramname">&gt;=0</td><td>Success, reply with return value.</td></tr>
</table>
</dd>
</dl>
<p>This function must be implemented by application specific server objects. </p>
<p>Implemented in <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Derived, IFACE, BASE, bool &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Block_dev&lt; Ds_data &gt;, L4virtio::Device &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Null_handler, L4::Kobject &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Stats_reader, Virtio_net_switch::Statistics_if &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Switch_factory, L4::Factory &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Virtio_gpio&lt; Request_handler, L4virtio::Device &gt;, L4virtio::Device &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Virtio_i2c&lt; Request_handler, L4virtio::Device &gt;, L4virtio::Device &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Virtio_net, L4virtio::Device &gt;</a>, <a class="el" href="structL4_1_1Epiface__t.html#a30b91b761ac824a55f48cb15d3ba6bfa">L4::Epiface_t&lt; Virtio_rng&lt; Rnd_state &gt;, L4virtio::Device &gt;</a>, <a class="el" href="structL4_1_1Irqep__t.html#acde9b9d1d25df85492715b6373fc7c7f">L4::Irqep_t&lt; Derived, BASE, bool &gt;</a>, <a class="el" href="structL4_1_1Irqep__t.html#acde9b9d1d25df85492715b6373fc7c7f">L4::Irqep_t&lt; Del_cap_irq &gt;</a>, <a class="el" href="structL4_1_1Irqep__t.html#acde9b9d1d25df85492715b6373fc7c7f">L4::Irqep_t&lt; Host_irq &gt;</a>, <a class="el" href="structL4_1_1Irqep__t.html#acde9b9d1d25df85492715b6373fc7c7f">L4::Irqep_t&lt; Irq_object &gt;</a>, <a class="el" href="structL4_1_1Irqep__t.html#acde9b9d1d25df85492715b6373fc7c7f">L4::Irqep_t&lt; Kick_irq &gt;</a>, and <a class="el" href="classL4_1_1Server__object.html#aae08d8562484fc0f1ad5685cdd3efecd">L4::Server_object</a>.</p>
<p class="reference">Referenced by <a class="el" href="ipc__epiface_source.html#l00554">L4::Basic_registry::dispatch()</a>.</p>
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="structL4_1_1Epiface_aa77168d1ca477f5f7e72c4535f143381_icgraph.svg" width="352" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ade91f9c2edbdec88a1d1c9a6cf43a533" name="ade91f9c2edbdec88a1d1c9a6cf43a533"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade91f9c2edbdec88a1d1c9a6cf43a533">&#9670;&#160;</a></span>get_buffer_demand()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="#a3b6915f6a99478aa323219cb5441cd24">Demand</a> L4::Epiface::get_buffer_demand </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the server-side receive buffer demand for this object. </p>
<dl class="section note"><dt>Note</dt><dd>This function is usually not implemented directly, but by using <a class="el" href="structL4_1_1Server__object__t.html" title="Base class (template) for server implementing server objects.">Server_object_t</a> template with an IPC interface definition. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The needed server-side receive buffers for this object </dd></dl>
<p>Implemented in <a class="el" href="structL4_1_1Epiface__t0.html#a180eb2c1be5e27d44d27b5e260a81245">L4::Epiface_t0&lt; RPC_IFACE, BASE &gt;</a>, <a class="el" href="structL4_1_1Epiface__t0.html#a180eb2c1be5e27d44d27b5e260a81245">L4::Epiface_t0&lt; IFACE, L4::Epiface &gt;</a>, <a class="el" href="structL4_1_1Epiface__t0.html#a180eb2c1be5e27d44d27b5e260a81245">L4::Epiface_t0&lt; L4::Factory, L4::Epiface &gt;</a>, <a class="el" href="structL4_1_1Epiface__t0.html#a180eb2c1be5e27d44d27b5e260a81245">L4::Epiface_t0&lt; L4::Kobject, L4::Epiface &gt;</a>, <a class="el" href="structL4_1_1Epiface__t0.html#a180eb2c1be5e27d44d27b5e260a81245">L4::Epiface_t0&lt; L4virtio::Device, L4::Epiface &gt;</a>, <a class="el" href="structL4_1_1Epiface__t0.html#a180eb2c1be5e27d44d27b5e260a81245">L4::Epiface_t0&lt; Virtio_net_switch::Statistics_if, L4::Epiface &gt;</a>, <a class="el" href="structL4_1_1Epiface__t0.html#a180eb2c1be5e27d44d27b5e260a81245">L4::Epiface_t0&lt; void, Epiface &gt;</a>, <a class="el" href="structL4_1_1Server__object__t.html#abbba74affbdf1da97e8992524976073d">L4::Server_object_t&lt; IFACE, BASE &gt;</a>, <a class="el" href="structL4_1_1Server__object__t.html#abbba74affbdf1da97e8992524976073d">L4::Server_object_t&lt; IFACE, L4::Server_object &gt;</a>, and <a class="el" href="structL4_1_1Server__object__t.html#abbba74affbdf1da97e8992524976073d">L4::Server_object_t&lt; Kobject &gt;</a>.</p>
</div>
</div>
<a id="a0d454b9446bdf9e317b09574a5155fe0" name="a0d454b9446bdf9e317b09574a5155fe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d454b9446bdf9e317b09574a5155fe0">&#9670;&#160;</a></span>obj_cap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Stored_cap L4::Epiface::obj_cap </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the capability to the kernel object belonging to this object. </p>
<dl class="section return"><dt>Returns</dt><dd>Capability for the kernel object behind the server.</dd></dl>
<p>This is usually either an <a class="el" href="classL4_1_1Ipc__gate.html" title="The C++ IPC gate interface, see IPC-Gate API for the C interface.">Ipc_gate</a> or an <a class="el" href="classL4_1_1Irq.html" title="C++ Irq interface, see IRQs for the C interface.">Irq</a>. </p>
<p class="definition">Definition at line <a class="el" href="ipc__epiface_source.html#l00206">206</a> of file <a class="el" href="ipc__epiface_source.html">ipc_epiface</a>.</p>
<p class="reference">Referenced by <a class="el" href="object__registry_source.html#l00262">L4Re::Util::Object_registry::unregister_obj()</a>.</p>
<div id="dynsection-3" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="structL4_1_1Epiface_a0d454b9446bdf9e317b09574a5155fe0_icgraph.svg" width="388" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a9605834c855375364504bd0f7ae78273" name="a9605834c855375364504bd0f7ae78273"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9605834c855375364504bd0f7ae78273">&#9670;&#160;</a></span>server_iface()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#aeec53d54ab6eb8e660679cdda1102fd7">Server_iface</a> * L4::Epiface::server_iface </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get pointer to server interface at which the object is currently registered. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the server at which the object is currently registered, NULL if the object is not registered at any server. </dd></dl>
<p class="definition">Definition at line <a class="el" href="ipc__epiface_source.html#l00213">213</a> of file <a class="el" href="ipc__epiface_source.html">ipc_epiface</a>.</p>
<p class="reference">Referenced by <a class="el" href="virtio-gpio-device_source.html#l00522">L4virtio::Svr::Virtio_gpio&lt; Request_handler, Epiface &gt;::register_single_driver_irq()</a>, <a class="el" href="virtio-i2c-device_source.html#l00363">L4virtio::Svr::Virtio_i2c&lt; Request_handler, Epiface &gt;::register_single_driver_irq()</a>, <a class="el" href="virtio-rng-device_source.html#l00210">L4virtio::Svr::Virtio_rng&lt; Rnd_state, Epiface &gt;::register_single_driver_irq()</a>, and <a class="el" href="l4re-snapshot-25_808_80_2src_2l4_2pkg_2virtio-net-switch_2server_2switch_2virtio__net_8h_source.html#l00250">Virtio_net::register_single_driver_irq()</a>.</p>
<div id="dynsection-4" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="structL4_1_1Epiface_a9605834c855375364504bd0f7ae78273_icgraph.svg" width="363" height="288"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="af47d6b2877fa4a09e04140a6644631aa" name="af47d6b2877fa4a09e04140a6644631aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af47d6b2877fa4a09e04140a6644631aa">&#9670;&#160;</a></span>set_server()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int L4::Epiface::set_server </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#aeec53d54ab6eb8e660679cdda1102fd7">Server_iface</a> *</td> <td class="paramname"><span class="paramname"><em>srv</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classL4_1_1Cap.html">Cap</a>&lt; void &gt;</td> <td class="paramname"><span class="paramname"><em>cap</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>managed</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set server registration info for the object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">srv</td><td>The server to register at </td></tr>
<tr><td class="paramname">cap</td><td>The capability that connects the object. </td></tr>
<tr><td class="paramname">managed</td><td>Mark the capability as managed or unmanaged. Typical server implementations use this flag to remember whether the capability was internally allocated or not. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -L4_EINVAL if the srv and cap are not consistent. </dd></dl>
<p class="definition">Definition at line <a class="el" href="ipc__epiface_source.html#l00224">224</a> of file <a class="el" href="ipc__epiface_source.html">ipc_epiface</a>.</p>
<p class="reference">References <a class="el" href="err_8h_source.html#l00046">L4_EINVAL</a>.</p>
<p class="reference">Referenced by <a class="el" href="object__registry_source.html#l00262">L4Re::Util::Object_registry::unregister_obj()</a>.</p>
<div id="dynsection-5" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="structL4_1_1Epiface_af47d6b2877fa4a09e04140a6644631aa_icgraph.svg" width="407" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>l4/sys/cxx/<a class="el" href="ipc__epiface_source.html">ipc_epiface</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</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"><a href="namespaceL4.html">L4</a></li><li class="navelem"><a href="structL4_1_1Epiface.html">Epiface</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>