167 lines
10 KiB
HTML
167 lines
10 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: l4shmc_ringbuf_t 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('structl4shmc__ringbuf__t.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">l4shmc_ringbuf_t Struct Reference<div class="ingroups"><a class="el" href="group__api__l4shm__ringbuf.html">L4SHM-based ring buffer implementation</a> » <a class="el" href="group__api__l4shm__ringbuf__internal.html">Internal</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Ring buffer.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="ringbuf_8h_source.html">ringbuf.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 l4shmc_ringbuf_t:</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="structl4shmc__ringbuf__t__coll__graph.svg" width="176" height="432"><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-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a382c625788eb10a55ffdcfac73f9cf3d" id="r_a382c625788eb10a55ffdcfac73f9cf3d"><td class="memItemLeft" align="right" valign="top"><a id="a382c625788eb10a55ffdcfac73f9cf3d" name="a382c625788eb10a55ffdcfac73f9cf3d"></a>
|
|
l4shmc_area_t * </td><td class="memItemRight" valign="bottom"><b>_area</b></td></tr>
|
|
<tr class="memdesc:a382c625788eb10a55ffdcfac73f9cf3d"><td class="mdescLeft"> </td><td class="mdescRight">L4SHM area this buffer is located in. <br /></td></tr>
|
|
<tr class="memitem:a597c7952cb89dc695330096bcea8d165" id="r_a597c7952cb89dc695330096bcea8d165"><td class="memItemLeft" align="right" valign="top"><a id="a597c7952cb89dc695330096bcea8d165" name="a597c7952cb89dc695330096bcea8d165"></a>
|
|
<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> </td><td class="memItemRight" valign="bottom"><b>_owner</b></td></tr>
|
|
<tr class="memdesc:a597c7952cb89dc695330096bcea8d165"><td class="mdescLeft"> </td><td class="mdescRight">owner (attached to send/recv signal) <br /></td></tr>
|
|
<tr class="memitem:a3862bfc8e3336eabc1bd7bd92d376143" id="r_a3862bfc8e3336eabc1bd7bd92d376143"><td class="memItemLeft" align="right" valign="top"><a id="a3862bfc8e3336eabc1bd7bd92d376143" name="a3862bfc8e3336eabc1bd7bd92d376143"></a>
|
|
l4shmc_chunk_t </td><td class="memItemRight" valign="bottom"><b>_chunk</b></td></tr>
|
|
<tr class="memdesc:a3862bfc8e3336eabc1bd7bd92d376143"><td class="mdescLeft"> </td><td class="mdescRight">chunk descriptor <br /></td></tr>
|
|
<tr class="memitem:a66f84d52e916ec45c49837dc0d68eee9" id="r_a66f84d52e916ec45c49837dc0d68eee9"><td class="memItemLeft" align="right" valign="top"><a id="a66f84d52e916ec45c49837dc0d68eee9" name="a66f84d52e916ec45c49837dc0d68eee9"></a>
|
|
unsigned </td><td class="memItemRight" valign="bottom"><b>_size</b></td></tr>
|
|
<tr class="memdesc:a66f84d52e916ec45c49837dc0d68eee9"><td class="mdescLeft"> </td><td class="mdescRight">chunk size // XXX do we need this? <br /></td></tr>
|
|
<tr class="memitem:a97e53b757b1ba7ed92a4ecd05f269223" id="r_a97e53b757b1ba7ed92a4ecd05f269223"><td class="memItemLeft" align="right" valign="top"><a id="a97e53b757b1ba7ed92a4ecd05f269223" name="a97e53b757b1ba7ed92a4ecd05f269223"></a>
|
|
char * </td><td class="memItemRight" valign="bottom"><b>_chunkname</b></td></tr>
|
|
<tr class="memdesc:a97e53b757b1ba7ed92a4ecd05f269223"><td class="mdescLeft"> </td><td class="mdescRight">name of the ring buffer chunk <br /></td></tr>
|
|
<tr class="memitem:a2ce44d3c35cf8e541d933b0a1580b594" id="r_a2ce44d3c35cf8e541d933b0a1580b594"><td class="memItemLeft" align="right" valign="top"><a id="a2ce44d3c35cf8e541d933b0a1580b594" name="a2ce44d3c35cf8e541d933b0a1580b594"></a>
|
|
char * </td><td class="memItemRight" valign="bottom"><b>_signame</b></td></tr>
|
|
<tr class="memdesc:a2ce44d3c35cf8e541d933b0a1580b594"><td class="mdescLeft"> </td><td class="mdescRight">base name of the ring buffer signals <br /></td></tr>
|
|
<tr class="memitem:a527d7c00a87b135908a6c578f2a43969" id="r_a527d7c00a87b135908a6c578f2a43969"><td class="memItemLeft" align="right" valign="top"><a id="a527d7c00a87b135908a6c578f2a43969" name="a527d7c00a87b135908a6c578f2a43969"></a>
|
|
<a class="el" href="structl4shmc__ringbuf__head__t.html">l4shmc_ringbuf_head_t</a> * </td><td class="memItemRight" valign="bottom"><b>_addr</b></td></tr>
|
|
<tr class="memdesc:a527d7c00a87b135908a6c578f2a43969"><td class="mdescLeft"> </td><td class="mdescRight">pointer to ring buffer head <br /></td></tr>
|
|
<tr class="memitem:a50a33214a3a63c74386d7e85d0f5b6bf" id="r_a50a33214a3a63c74386d7e85d0f5b6bf"><td class="memItemLeft" align="right" valign="top"><a id="a50a33214a3a63c74386d7e85d0f5b6bf" name="a50a33214a3a63c74386d7e85d0f5b6bf"></a>
|
|
l4shmc_signal_t </td><td class="memItemRight" valign="bottom"><b>_signal_full</b></td></tr>
|
|
<tr class="memdesc:a50a33214a3a63c74386d7e85d0f5b6bf"><td class="mdescLeft"> </td><td class="mdescRight">"full" signal - triggered when data is produced <br /></td></tr>
|
|
<tr class="memitem:ae833494bf78923e982bbc8da08cc512f" id="r_ae833494bf78923e982bbc8da08cc512f"><td class="memItemLeft" align="right" valign="top"><a id="ae833494bf78923e982bbc8da08cc512f" name="ae833494bf78923e982bbc8da08cc512f"></a>
|
|
l4shmc_signal_t </td><td class="memItemRight" valign="bottom"><b>_signal_empty</b></td></tr>
|
|
<tr class="memdesc:ae833494bf78923e982bbc8da08cc512f"><td class="mdescLeft"> </td><td class="mdescRight">"empty" signal - triggered when data is consumed <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Ring buffer. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ringbuf_8h_source.html#l00085">85</a> of file <a class="el" href="ringbuf_8h_source.html">ringbuf.h</a>.</p>
|
|
</div><hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>l4/shmc/<a class="el" href="ringbuf_8h_source.html">ringbuf.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="structl4shmc__ringbuf__t.html">l4shmc_ringbuf_t</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>
|