MCB1700_Welcome/Doxygen/html/structx_s_t_r_e_a_m___b_u_f...

237 lines
11 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">
<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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Labor04: xSTREAM_BUFFER 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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Labor04
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structx_s_t_r_e_a_m___b_u_f_f_e_r.html',''); initResizable(); });
/* @license-end */
</script>
<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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">xSTREAM_BUFFER Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a6eedf625958216bba9136d98dcfed196"><td class="memItemLeft" align="right" valign="top">volatile size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#a6eedf625958216bba9136d98dcfed196">xTail</a></td></tr>
<tr class="separator:a6eedf625958216bba9136d98dcfed196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a003e281d830468b1faabf4ba820f5ad0"><td class="memItemLeft" align="right" valign="top">volatile size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#a003e281d830468b1faabf4ba820f5ad0">xHead</a></td></tr>
<tr class="separator:a003e281d830468b1faabf4ba820f5ad0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ba6056c7e598ac40b4542c3b1614315"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#a1ba6056c7e598ac40b4542c3b1614315">xLength</a></td></tr>
<tr class="separator:a1ba6056c7e598ac40b4542c3b1614315"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cc97a6ea4374a84aa4d1453459ffce4"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#a9cc97a6ea4374a84aa4d1453459ffce4">xTriggerLevelBytes</a></td></tr>
<tr class="separator:a9cc97a6ea4374a84aa4d1453459ffce4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae9dce0a57e217492d5511b8f728d165"><td class="memItemLeft" align="right" valign="top">volatile <a class="el" href="task_8h.html#ae95f44d4cfeb4a599c6cc258d241cb6b">TaskHandle_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#aae9dce0a57e217492d5511b8f728d165">xTaskWaitingToReceive</a></td></tr>
<tr class="separator:aae9dce0a57e217492d5511b8f728d165"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcac505e0e57d53096673aae517ba651"><td class="memItemLeft" align="right" valign="top">volatile <a class="el" href="task_8h.html#ae95f44d4cfeb4a599c6cc258d241cb6b">TaskHandle_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#adcac505e0e57d53096673aae517ba651">xTaskWaitingToSend</a></td></tr>
<tr class="separator:adcac505e0e57d53096673aae517ba651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8c28e51282198825d5ad0c2d666623a"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#aa8c28e51282198825d5ad0c2d666623a">pucBuffer</a></td></tr>
<tr class="separator:aa8c28e51282198825d5ad0c2d666623a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8f6da769d17b9653e9a6d879e875e9b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html#ab8f6da769d17b9653e9a6d879e875e9b">ucFlags</a></td></tr>
<tr class="separator:ab8f6da769d17b9653e9a6d879e875e9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="aa8c28e51282198825d5ad0c2d666623a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8c28e51282198825d5ad0c2d666623a">&#9670;&nbsp;</a></span>pucBuffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* pucBuffer</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab8f6da769d17b9653e9a6d879e875e9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8f6da769d17b9653e9a6d879e875e9b">&#9670;&nbsp;</a></span>ucFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ucFlags</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a003e281d830468b1faabf4ba820f5ad0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a003e281d830468b1faabf4ba820f5ad0">&#9670;&nbsp;</a></span>xHead</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile size_t xHead</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1ba6056c7e598ac40b4542c3b1614315"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ba6056c7e598ac40b4542c3b1614315">&#9670;&nbsp;</a></span>xLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t xLength</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6eedf625958216bba9136d98dcfed196"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eedf625958216bba9136d98dcfed196">&#9670;&nbsp;</a></span>xTail</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile size_t xTail</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aae9dce0a57e217492d5511b8f728d165"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae9dce0a57e217492d5511b8f728d165">&#9670;&nbsp;</a></span>xTaskWaitingToReceive</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile <a class="el" href="task_8h.html#ae95f44d4cfeb4a599c6cc258d241cb6b">TaskHandle_t</a> xTaskWaitingToReceive</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adcac505e0e57d53096673aae517ba651"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcac505e0e57d53096673aae517ba651">&#9670;&nbsp;</a></span>xTaskWaitingToSend</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile <a class="el" href="task_8h.html#ae95f44d4cfeb4a599c6cc258d241cb6b">TaskHandle_t</a> xTaskWaitingToSend</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9cc97a6ea4374a84aa4d1453459ffce4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cc97a6ea4374a84aa4d1453459ffce4">&#9670;&nbsp;</a></span>xTriggerLevelBytes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t xTriggerLevelBytes</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="stream__buffer_8c.html">stream_buffer.c</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structx_s_t_r_e_a_m___b_u_f_f_e_r.html">xSTREAM_BUFFER</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>