224 lines
12 KiB
HTML
224 lines
12 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: Net_transfer 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="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('classNet__transfer.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">Net_transfer Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span><div class="ingroups"><a class="el" href="group__virtio__net__switch.html">Virtio Net Switch</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A network request to only a single destination.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="request_8h_source.html">request.h</a>></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>Collaboration diagram for Net_transfer:</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="classNet__transfer__coll__graph.svg" width="151" height="502"><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-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a221a489d9df8a54c4e9d5df123aba126" id="r_a221a489d9df8a54c4e9d5df123aba126"><td class="memItemLeft" align="right" valign="top"><a id="a221a489d9df8a54c4e9d5df123aba126" name="a221a489d9df8a54c4e9d5df123aba126"></a>
|
|
void const * </td><td class="memItemRight" valign="bottom"><b>req_id</b> () const</td></tr>
|
|
<tr class="memdesc:a221a489d9df8a54c4e9d5df123aba126"><td class="mdescLeft"> </td><td class="mdescRight">Identifier for the underlying <span class="tt">Net_request</span>, used for logging purposes. <br /></td></tr>
|
|
<tr class="memitem:a03a0e6103c0f7d31bdce2150dc45e7c5" id="r_a03a0e6103c0f7d31bdce2150dc45e7c5"><td class="memItemLeft" align="right" valign="top"><a id="a03a0e6103c0f7d31bdce2150dc45e7c5" name="a03a0e6103c0f7d31bdce2150dc45e7c5"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>copy_header</b> (Virtio_net::Hdr *dst_header) const =0</td></tr>
|
|
<tr class="memdesc:a03a0e6103c0f7d31bdce2150dc45e7c5"><td class="mdescLeft"> </td><td class="mdescRight">Populate the virtio-net header for the destination. <br /></td></tr>
|
|
<tr class="memitem:ae6ef29e7ea5ef5e5e9577b0be3a3b62f" id="r_ae6ef29e7ea5ef5e5e9577b0be3a3b62f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structBuffer.html">Buffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6ef29e7ea5ef5e5e9577b0be3a3b62f">cur_buf</a> ()</td></tr>
|
|
<tr class="memdesc:ae6ef29e7ea5ef5e5e9577b0be3a3b62f"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> containing (a part of) the packet data. <br /></td></tr>
|
|
<tr class="memitem:a35cd3e24de6dc86e60e38f34ad9f5298" id="r_a35cd3e24de6dc86e60e38f34ad9f5298"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a35cd3e24de6dc86e60e38f34ad9f5298">done</a> ()=0</td></tr>
|
|
<tr class="memdesc:a35cd3e24de6dc86e60e38f34ad9f5298"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the transfer has been completed, i.e. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A network request to only a single destination. </p>
|
|
<p>A <span class="tt">Net_request</span> can have multiple destinations (being a broadcast request, for example). That is why it is processed by multiple <span class="tt"><a class="el" href="classNet__transfer.html" title="A network request to only a single destination.">Net_transfer</a></span>s, each representing the delivery to a single destination port.</p>
|
|
<p><span class="tt">Port_iface::handle_request</span> uses the <span class="tt"><a class="el" href="classNet__transfer.html" title="A network request to only a single destination.">Net_transfer</a></span> to move one packet to the destination of the request. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="request_8h_source.html#l00033">33</a> of file <a class="el" href="request_8h_source.html">request.h</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="ae6ef29e7ea5ef5e5e9577b0be3a3b62f" name="ae6ef29e7ea5ef5e5e9577b0be3a3b62f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6ef29e7ea5ef5e5e9577b0be3a3b62f">◆ </a></span>cur_buf()</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="structBuffer.html">Buffer</a> & Net_transfer::cur_buf </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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><a class="el" href="structBuffer.html" title="Data buffer used to transfer packets.">Buffer</a> containing (a part of) the packet data. </p>
|
|
<p>Once emptied, a call to <span class="tt"><a class="el" href="#a35cd3e24de6dc86e60e38f34ad9f5298" title="Check whether the transfer has been completed, i.e.">done()</a></span> might replenish the buffer, in case the net request consisted of multiple chained buffers. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="request_8h_source.html#l00054">54</a> of file <a class="el" href="request_8h_source.html">request.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35cd3e24de6dc86e60e38f34ad9f5298" name="a35cd3e24de6dc86e60e38f34ad9f5298"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35cd3e24de6dc86e60e38f34ad9f5298">◆ </a></span>done()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool Net_transfer::done </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Check whether the transfer has been completed, i.e. </p>
|
|
<p>the entire packet data has been copied.</p>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">false</td><td>There is remaining packet data that needs to be copied. </td></tr>
|
|
<tr><td class="paramname">true</td><td>The entire packet data has been copied.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="structL4virtio_1_1Svr_1_1Bad__descriptor.html" title="Exception used by Queue to indicate descriptor errors.">L4virtio::Svr::Bad_descriptor</a></td><td>Exception raised in SRC port queue. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>pkg/virtio-net-switch/server/switch/<a class="el" href="request_8h_source.html">request.h</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="classNet__transfer.html">Net_transfer</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>
|