469 lines
23 KiB
HTML
469 lines
23 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: Chunks</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('group__api__l4shmc__chunk.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">Chunks <div class="ingroups"><a class="el" href="group__api__l4shm.html">Shared Memory Library</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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 Chunks:</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="group__api__l4shmc__chunk.svg" width="440" height="86"><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-groups" class="groupheader"><a id="groups" name="groups"></a>
|
|
Topics</h2></td></tr>
|
|
<tr class="memitem:api_5Fl4shmc_5Fchunk_5Fprod" id="r_api_5Fl4shmc_5Fchunk_5Fprod"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__prod.html">Producer </a></td></tr>
|
|
<tr class="memitem:api_5Fl4shmc_5Fchunk_5Fcons" id="r_api_5Fl4shmc_5Fchunk_5Fcons"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4shmc__chunk__cons.html">Consumer </a></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaacecac77ae23e653e1246f2b46934324" id="r_gaacecac77ae23e653e1246f2b46934324"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaacecac77ae23e653e1246f2b46934324">l4shmc_add_chunk</a> (l4shmc_area_t *shmarea, char const *chunk_name, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> chunk_capacity, l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:gaacecac77ae23e653e1246f2b46934324"><td class="mdescLeft"> </td><td class="mdescRight">Add a chunk in the shared memory area. <br /></td></tr>
|
|
<tr class="memitem:ga3e2f5aadb44747d7c8310d38289a98fb" id="r_ga3e2f5aadb44747d7c8310d38289a98fb"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3e2f5aadb44747d7c8310d38289a98fb">l4shmc_get_chunk</a> (l4shmc_area_t *shmarea, char const *chunk_name, l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:ga3e2f5aadb44747d7c8310d38289a98fb"><td class="mdescLeft"> </td><td class="mdescRight">Get chunk out of shared memory area. <br /></td></tr>
|
|
<tr class="memitem:gac72e7a7c8c7538f46465124fa50f38a4" id="r_gac72e7a7c8c7538f46465124fa50f38a4"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac72e7a7c8c7538f46465124fa50f38a4">l4shmc_get_chunk_to</a> (l4shmc_area_t *shmarea, char const *chunk_name, <a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a> timeout_ms, l4shmc_chunk_t *chunk)</td></tr>
|
|
<tr class="memdesc:gac72e7a7c8c7538f46465124fa50f38a4"><td class="mdescLeft"> </td><td class="mdescRight">Get chunk out of shared memory area, with timeout. <br /></td></tr>
|
|
<tr class="memitem:ga31d12658a159af46afa9f016343fb0c8" id="r_ga31d12658a159af46afa9f016343fb0c8"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga31d12658a159af46afa9f016343fb0c8">l4shmc_iterate_chunk</a> (l4shmc_area_t const *shmarea, char const **chunk_name, long offs)</td></tr>
|
|
<tr class="memdesc:ga31d12658a159af46afa9f016343fb0c8"><td class="mdescLeft"> </td><td class="mdescRight">Iterate over names of all existing chunks. <br /></td></tr>
|
|
<tr class="memitem:gae3d6557c03fec27dbb348ef52bcbc3a6" id="r_gae3d6557c03fec27dbb348ef52bcbc3a6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae3d6557c03fec27dbb348ef52bcbc3a6">l4shmc_chunk_ptr</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:gae3d6557c03fec27dbb348ef52bcbc3a6"><td class="mdescLeft"> </td><td class="mdescRight">Get data pointer to chunk. <br /></td></tr>
|
|
<tr class="memitem:gac6cbec9505bb9d7c7dfac881a602235b" id="r_gac6cbec9505bb9d7c7dfac881a602235b"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac6cbec9505bb9d7c7dfac881a602235b">l4shmc_chunk_capacity</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:gac6cbec9505bb9d7c7dfac881a602235b"><td class="mdescLeft"> </td><td class="mdescRight">Get capacity of a chunk. <br /></td></tr>
|
|
<tr class="memitem:ga55b848686a0629e8aa44308acc29f8a5" id="r_ga55b848686a0629e8aa44308acc29f8a5"><td class="memItemLeft" align="right" valign="top">l4shmc_signal_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga55b848686a0629e8aa44308acc29f8a5">l4shmc_chunk_signal</a> (l4shmc_chunk_t const *chunk)</td></tr>
|
|
<tr class="memdesc:ga55b848686a0629e8aa44308acc29f8a5"><td class="mdescLeft"> </td><td class="mdescRight">Get the registered signal of a chunk. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
|
|
<a id="gaacecac77ae23e653e1246f2b46934324" name="gaacecac77ae23e653e1246f2b46934324"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaacecac77ae23e653e1246f2b46934324">◆ </a></span>l4shmc_add_chunk()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long l4shmc_add_chunk </td>
|
|
<td>(</td>
|
|
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>chunk_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a></td> <td class="paramname"><span class="paramname"><em>chunk_capacity</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">l4shmc_chunk_t *</td> <td class="paramname"><span class="paramname"><em>chunk</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a chunk in the shared memory area. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">shmarea</td><td>The shared memory area to put the chunk in. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">chunk_name</td><td>Name of the chunk. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">chunk_capacity</td><td>Capacity for payload of the chunk in bytes. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">chunk</td><td>Chunk structure to fill in.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>Success. </td></tr>
|
|
<tr><td class="paramname"><0</td><td>Error. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a4">examples/libs/shmc/prodcons.c</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac6cbec9505bb9d7c7dfac881a602235b" name="gac6cbec9505bb9d7c7dfac881a602235b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac6cbec9505bb9d7c7dfac881a602235b">◆ </a></span>l4shmc_chunk_capacity()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long l4shmc_chunk_capacity </td>
|
|
<td>(</td>
|
|
<td class="paramtype">l4shmc_chunk_t const *</td> <td class="paramname"><span class="paramname"><em>chunk</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>Get capacity of a chunk. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chunk</td><td>Chunk.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Capacity of the chunk in bytes. </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, and <a class="el" href="compiler_8h_source.html#l00051">L4_INLINE</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae3d6557c03fec27dbb348ef52bcbc3a6" name="gae3d6557c03fec27dbb348ef52bcbc3a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae3d6557c03fec27dbb348ef52bcbc3a6">◆ </a></span>l4shmc_chunk_ptr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void * l4shmc_chunk_ptr </td>
|
|
<td>(</td>
|
|
<td class="paramtype">l4shmc_chunk_t const *</td> <td class="paramname"><span class="paramname"><em>chunk</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>Get data pointer to chunk. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chunk</td><td>Chunk.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Chunk pointer. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a14">examples/libs/shmc/prodcons.c</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, and <a class="el" href="compiler_8h_source.html#l00051">L4_INLINE</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga55b848686a0629e8aa44308acc29f8a5" name="ga55b848686a0629e8aa44308acc29f8a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga55b848686a0629e8aa44308acc29f8a5">◆ </a></span>l4shmc_chunk_signal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">l4shmc_signal_t * l4shmc_chunk_signal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">l4shmc_chunk_t const *</td> <td class="paramname"><span class="paramname"><em>chunk</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>Get the registered signal of a chunk. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">chunk</td><td>Chunk.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>No signal has been registered with this chunk. </td></tr>
|
|
<tr><td class="paramname">!=0</td><td>Pointer to signal otherwise. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>, and <a class="el" href="compiler_8h_source.html#l00051">L4_INLINE</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3e2f5aadb44747d7c8310d38289a98fb" name="ga3e2f5aadb44747d7c8310d38289a98fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3e2f5aadb44747d7c8310d38289a98fb">◆ </a></span>l4shmc_get_chunk()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long l4shmc_get_chunk </td>
|
|
<td>(</td>
|
|
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>chunk_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">l4shmc_chunk_t *</td> <td class="paramname"><span class="paramname"><em>chunk</em></span> )</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 chunk out of shared memory area. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">shmarea</td><td>Shared memory area. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">chunk_name</td><td>Name of the chunk. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">chunk</td><td>Chunk data structure to fill.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>Success. </td></tr>
|
|
<tr><td class="paramname"><0</td><td>Error. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2libs_2shmc_2prodcons_8c-example.html#a18">examples/libs/shmc/prodcons.c</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac72e7a7c8c7538f46465124fa50f38a4" name="gac72e7a7c8c7538f46465124fa50f38a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac72e7a7c8c7538f46465124fa50f38a4">◆ </a></span>l4shmc_get_chunk_to()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long l4shmc_get_chunk_to </td>
|
|
<td>(</td>
|
|
<td class="paramtype">l4shmc_area_t *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>chunk_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#ga1c2c4b333f75b1d05b59855910f2b9cb">l4_umword_t</a></td> <td class="paramname"><span class="paramname"><em>timeout_ms</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">l4shmc_chunk_t *</td> <td class="paramname"><span class="paramname"><em>chunk</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get chunk out of shared memory area, with timeout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">shmarea</td><td>Shared memory area. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">chunk_name</td><td>Name of the chunk. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">timeout_ms</td><td>Timeout in milliseconds to wait for the chunk to appear in the shared memory area. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">chunk</td><td>Chunk data structure to fill.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>Success. </td></tr>
|
|
<tr><td class="paramname"><0</td><td>Error. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga31d12658a159af46afa9f016343fb0c8" name="ga31d12658a159af46afa9f016343fb0c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga31d12658a159af46afa9f016343fb0c8">◆ </a></span>l4shmc_iterate_chunk()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long l4shmc_iterate_chunk </td>
|
|
<td>(</td>
|
|
<td class="paramtype">l4shmc_area_t const *</td> <td class="paramname"><span class="paramname"><em>shmarea</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const **</td> <td class="paramname"><span class="paramname"><em>chunk_name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>offs</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Iterate over names of all existing chunks. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">shmarea</td><td>Shared memory area. </td></tr>
|
|
<tr><td class="paramname">chunk_name</td><td>Where the name of the current chunk will be stored </td></tr>
|
|
<tr><td class="paramname">offs</td><td>0 to start iteration, return value of previous call to <a class="el" href="#ga31d12658a159af46afa9f016343fb0c8" title="Iterate over names of all existing chunks.">l4shmc_iterate_chunk()</a> to get next chunk</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>No more chunks available. </td></tr>
|
|
<tr><td class="paramname"><0</td><td>Error. </td></tr>
|
|
<tr><td class="paramname">>0</td><td>Iterator value for the next call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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="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>
|