178 lines
9.1 KiB
HTML
178 lines
9.1 KiB
HTML
<!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" lang="zh">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||
<meta name="generator" content="Doxygen 1.9.7"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<title>BLE5.2: ring_buffer结构体 参考</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>
|
||
<script type="text/x-mathjax-config">
|
||
MathJax.Hub.Config({
|
||
extensions: ["tex2jax.js"],
|
||
jax: ["input/TeX","output/HTML-CSS"],
|
||
});
|
||
</script>
|
||
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
||
<link href="doxygen.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 id="projectrow">
|
||
<td id="projectlogo"><img alt="Logo" src="xinchip.png"/></td>
|
||
<td id="projectalign">
|
||
<div id="projectname">BLE5.2<span id="projectnumber"> 1.0</span>
|
||
</div>
|
||
<div id="projectbrief">开发文档说明</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- 制作者 Doxygen 1.9.7 -->
|
||
<div id="navrow1" class="tabs">
|
||
<ul class="tablist">
|
||
<li><a href="index.html"><span>首页</span></a></li>
|
||
<li><a href="pages.html"><span>相关页面</span></a></li>
|
||
<li class="current"><a href="annotated.html"><span>类</span></a></li>
|
||
<li><a href="files.html"><span>文件</span></a></li>
|
||
</ul>
|
||
</div>
|
||
<div id="navrow2" class="tabs2">
|
||
<ul class="tablist">
|
||
<li><a href="annotated.html"><span>类列表</span></a></li>
|
||
<li><a href="classes.html"><span>类索引</span></a></li>
|
||
<li><a href="functions.html"><span>类成员</span></a></li>
|
||
</ul>
|
||
</div>
|
||
</div><!-- top -->
|
||
<div class="header">
|
||
<div class="summary">
|
||
<a href="#pub-attribs">Public 属性</a> |
|
||
<a href="structring__buffer-members.html">所有成员列表</a> </div>
|
||
<div class="headertitle"><div class="title">ring_buffer结构体 参考</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p><code>#include <<a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a>></code></p>
|
||
<table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
||
Public 属性</h2></td></tr>
|
||
<tr class="memitem:a56ed84df35de10bdb65e72b184309497"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structring__buffer.html#a56ed84df35de10bdb65e72b184309497">buffer</a></td></tr>
|
||
<tr class="separator:a56ed84df35de10bdb65e72b184309497"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a85263b545cc9691fe0e2425d252b0e8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ringbuffer_8h.html#a52ec5f4714183db21259b6f7ea22db4e">ring_buffer_size_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structring__buffer.html#a85263b545cc9691fe0e2425d252b0e8a">size</a></td></tr>
|
||
<tr class="separator:a85263b545cc9691fe0e2425d252b0e8a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a90a908670b006a93258890bcadb0ad71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ringbuffer_8h.html#a52ec5f4714183db21259b6f7ea22db4e">ring_buffer_size_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structring__buffer.html#a90a908670b006a93258890bcadb0ad71">tail_index</a></td></tr>
|
||
<tr class="separator:a90a908670b006a93258890bcadb0ad71"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a5c10340bcd826308c9ef91f0a396f0c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ringbuffer_8h.html#a52ec5f4714183db21259b6f7ea22db4e">ring_buffer_size_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structring__buffer.html#a5c10340bcd826308c9ef91f0a396f0c1">head_index</a></td></tr>
|
||
<tr class="separator:a5c10340bcd826308c9ef91f0a396f0c1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a50629a7a82fd48b1f7e38c0661e766bb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structring__buffer.html#a50629a7a82fd48b1f7e38c0661e766bb">rx_lock</a></td></tr>
|
||
<tr class="separator:a50629a7a82fd48b1f7e38c0661e766bb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
|
||
<div class="textblock"><p>Used as a modulo operator as <code> a % b = (a & (b − 1)) </code> where <code>a</code> is a positive index in the buffer and <code>b</code> is the (power of two) size of the buffer. Structure which holds a ring buffer. The buffer contains a buffer array as well as metadata for the ring buffer. </p>
|
||
|
||
<p class="definition">在文件 <a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a> 第 <a class="el" href="ringbuffer_8h_source.html#l00046">46</a> 行定义.</p>
|
||
</div><h2 class="groupheader">类成员变量说明</h2>
|
||
<a id="a56ed84df35de10bdb65e72b184309497" name="a56ed84df35de10bdb65e72b184309497"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a56ed84df35de10bdb65e72b184309497">◆ </a></span>buffer</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">uint8_t* buffer</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Buffer memory. </p>
|
||
|
||
<p class="definition">在文件 <a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a> 第 <a class="el" href="ringbuffer_8h_source.html#l00049">49</a> 行定义.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a5c10340bcd826308c9ef91f0a396f0c1" name="a5c10340bcd826308c9ef91f0a396f0c1"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a5c10340bcd826308c9ef91f0a396f0c1">◆ </a></span>head_index</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="ringbuffer_8h.html#a52ec5f4714183db21259b6f7ea22db4e">ring_buffer_size_t</a> head_index</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Index of head. </p>
|
||
|
||
<p class="definition">在文件 <a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a> 第 <a class="el" href="ringbuffer_8h_source.html#l00055">55</a> 行定义.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a50629a7a82fd48b1f7e38c0661e766bb" name="a50629a7a82fd48b1f7e38c0661e766bb"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a50629a7a82fd48b1f7e38c0661e766bb">◆ </a></span>rx_lock</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">bool rx_lock</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Rx Locker. </p>
|
||
|
||
<p class="definition">在文件 <a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a> 第 <a class="el" href="ringbuffer_8h_source.html#l00057">57</a> 行定义.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a85263b545cc9691fe0e2425d252b0e8a" name="a85263b545cc9691fe0e2425d252b0e8a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a85263b545cc9691fe0e2425d252b0e8a">◆ </a></span>size</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="ringbuffer_8h.html#a52ec5f4714183db21259b6f7ea22db4e">ring_buffer_size_t</a> size</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Buffer size. </p>
|
||
|
||
<p class="definition">在文件 <a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a> 第 <a class="el" href="ringbuffer_8h_source.html#l00051">51</a> 行定义.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="a90a908670b006a93258890bcadb0ad71" name="a90a908670b006a93258890bcadb0ad71"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a90a908670b006a93258890bcadb0ad71">◆ </a></span>tail_index</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname"><a class="el" href="ringbuffer_8h.html#a52ec5f4714183db21259b6f7ea22db4e">ring_buffer_size_t</a> tail_index</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
<p>Index of tail. </p>
|
||
|
||
<p class="definition">在文件 <a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a> 第 <a class="el" href="ringbuffer_8h_source.html#l00053">53</a> 行定义.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<hr/>该结构体的文档由以下文件生成:<ul>
|
||
<li>TEST2/api/<a class="el" href="ringbuffer_8h_source.html">ringbuffer.h</a></li>
|
||
</ul>
|
||
</div><!-- contents -->
|
||
<!-- start footer part -->
|
||
<hr class="footer"/><address class="footer"><small>
|
||
制作者 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
|
||
</small></address>
|
||
</body>
|
||
</html>
|