begriffs open source - cmsis-freertos/blob - docs/General/html/group__freertos__evr__streambuf.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>Stream Buffer Functions</title>
   7 <title>CMSIS-FreeRTOS: Stream Buffer Functions</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <script type="text/javascript" src="printComponentTabs.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 </head>
  26 <body>
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr style="height: 46px;">
  32   <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33   <td style="padding-left: 0.5em;">
  34    <div id="projectname">CMSIS-FreeRTOS
  35    &#160;<span id="projectnumber">Version 10.3.1</span>
  36    </div>
  37    <div id="projectbrief">CMSIS-RTOS2 compliant FreeRTOS Implementation</div>
  38   </td>
  39  </tr>
  40  </tbody>
  41 </table>
  42 </div>
  43 <!-- end header part -->
  44 <div id="CMSISnav" class="tabs1">
  45     <ul class="tablist">
  46       <script type="text/javascript">
  47                 <!--
  48                 writeComponentTabs.call(this);
  49                 //-->
  50       </script>
  51           </ul>
  52 </div>
  53 <!-- Generated by Doxygen 1.8.6 -->
  54 <script type="text/javascript">
  55 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56 </script>
  57   <div id="navrow1" class="tabs">
  58     <ul class="tablist">
  59       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60       <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61       <li><a href="modules.html"><span>Reference</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80 </div><!-- top -->
  81 <div id="side-nav" class="ui-resizable side-nav-resizable">
  82   <div id="nav-tree">
  83     <div id="nav-tree-contents">
  84       <div id="nav-sync" class="sync"></div>
  85     </div>
  86   </div>
  87   <div id="splitbar" style="-moz-user-select:none;"
  88        class="ui-resizable-handle">
  89   </div>
  90 </div>
  91 <script type="text/javascript">
  92 $(document).ready(function(){initNavTree('group__freertos__evr__streambuf.html','');});
  93 </script>
  94 <div id="doc-content">
  95 <!-- window showing the filter options -->
  96 <div id="MSearchSelectWindow"
  97      onmouseover="return searchBox.OnSearchSelectShow()"
  98      onmouseout="return searchBox.OnSearchSelectHide()"
  99      onkeydown="return searchBox.OnSearchSelectKey(event)">
 100 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 101
 102 <!-- iframe showing the search results (closed by default) -->
 103 <div id="MSearchResultsWindow">
 104 <iframe src="javascript:void(0)" frameborder="0"
 105         name="MSearchResults" id="MSearchResults">
 106 </iframe>
 107 </div>
 108
 109 <div class="header">
 110   <div class="summary">
 111 <a href="#func-members">Functions</a>  </div>
 112   <div class="headertitle">
 113 <div class="title">Stream Buffer Functions<div class="ingroups"><a class="el" href="group__freertos__evr.html">Event functions</a></div></div>  </div>
 114 </div><!--header-->
 115 <div class="contents">
 116
 117 <p>Events generated by Stream Buffer and Message Buffer functions.
 118 <a href="#details">More...</a></p>
 119 <table class="memberdecls">
 120 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 121 Functions</h2></td></tr>
 122 <tr class="memitem:ga7a0a423c5e8c5d461c4e4e3a490b3d35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga7a0a423c5e8c5d461c4e4e3a490b3d35">EvrFreeRTOSStreamBuf_StreamBufferCreateFailed</a> (uint32_t uxIsMessageBuffer)</td></tr>
 123 <tr class="memdesc:ga7a0a423c5e8c5d461c4e4e3a490b3d35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful stream buffer object create (Error)  <a href="#ga7a0a423c5e8c5d461c4e4e3a490b3d35">More...</a><br/></td></tr>
 124 <tr class="separator:ga7a0a423c5e8c5d461c4e4e3a490b3d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:ga5ea642b6e42e189d987fe43997292136"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga5ea642b6e42e189d987fe43997292136">EvrFreeRTOSStreamBuf_StreamBufferCreateStaticFailed</a> (StreamBuffer_t pxStreamBuffer, uint32_t uxIsMessageBuffer)</td></tr>
 126 <tr class="memdesc:ga5ea642b6e42e189d987fe43997292136"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful stream buffer object create (Error)  <a href="#ga5ea642b6e42e189d987fe43997292136">More...</a><br/></td></tr>
 127 <tr class="separator:ga5ea642b6e42e189d987fe43997292136"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:gaeba2d793e2e75861beed404403c9bfab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#gaeba2d793e2e75861beed404403c9bfab">EvrFreeRTOSStreamBuf_StreamBufferCreate</a> (StreamBuffer_t pxStreamBuffer, uint32_t uxIsMessageBuffer)</td></tr>
 129 <tr class="memdesc:gaeba2d793e2e75861beed404403c9bfab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful stream buffer object create (Op)  <a href="#gaeba2d793e2e75861beed404403c9bfab">More...</a><br/></td></tr>
 130 <tr class="separator:gaeba2d793e2e75861beed404403c9bfab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:gabe9809fda02bbda1da38919a71a91d8f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#gabe9809fda02bbda1da38919a71a91d8f">EvrFreeRTOSStreamBuf_StreamBufferDelete</a> (StreamBuffer_t pxStreamBuffer)</td></tr>
 132 <tr class="memdesc:gabe9809fda02bbda1da38919a71a91d8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer object delete (Op)  <a href="#gabe9809fda02bbda1da38919a71a91d8f">More...</a><br/></td></tr>
 133 <tr class="separator:gabe9809fda02bbda1da38919a71a91d8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:ga3151e5298becca4377d20cea96eb4dd1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga3151e5298becca4377d20cea96eb4dd1">EvrFreeRTOSStreamBuf_StreamBufferReset</a> (StreamBuffer_t pxStreamBuffer)</td></tr>
 135 <tr class="memdesc:ga3151e5298becca4377d20cea96eb4dd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer object reset (Op)  <a href="#ga3151e5298becca4377d20cea96eb4dd1">More...</a><br/></td></tr>
 136 <tr class="separator:ga3151e5298becca4377d20cea96eb4dd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:ga12f2a913902bcea879c6705cef7d3f2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga12f2a913902bcea879c6705cef7d3f2f">EvrFreeRTOSStreamBuf_StreamBufferBlockingOnSend</a> (StreamBuffer_t pxStreamBuffer)</td></tr>
 138 <tr class="memdesc:ga12f2a913902bcea879c6705cef7d3f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer send when buffer is full and sending task is blocked (Op)  <a href="#ga12f2a913902bcea879c6705cef7d3f2f">More...</a><br/></td></tr>
 139 <tr class="separator:ga12f2a913902bcea879c6705cef7d3f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:ga6393f44cfcef26222c363adf23659e6b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga6393f44cfcef26222c363adf23659e6b">EvrFreeRTOSStreamBuf_StreamBufferSend</a> (StreamBuffer_t pxStreamBuffer, uint32_t xBytesSent)</td></tr>
 141 <tr class="memdesc:ga6393f44cfcef26222c363adf23659e6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer send when data is successfully copied into the buffer (Op)  <a href="#ga6393f44cfcef26222c363adf23659e6b">More...</a><br/></td></tr>
 142 <tr class="separator:ga6393f44cfcef26222c363adf23659e6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:ga6cb3b5c034a5dfcc8d7ddbc2aff2a1bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga6cb3b5c034a5dfcc8d7ddbc2aff2a1bc">EvrFreeRTOSStreamBuf_StreamBufferSendFailed</a> (StreamBuffer_t pxStreamBuffer)</td></tr>
 144 <tr class="memdesc:ga6cb3b5c034a5dfcc8d7ddbc2aff2a1bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer send when data is not copied into the buffer (Error)  <a href="#ga6cb3b5c034a5dfcc8d7ddbc2aff2a1bc">More...</a><br/></td></tr>
 145 <tr class="separator:ga6cb3b5c034a5dfcc8d7ddbc2aff2a1bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:gaa64809f12f9724d4625dcabe1b9ea563"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#gaa64809f12f9724d4625dcabe1b9ea563">EvrFreeRTOSStreamBuf_StreamBufferSendFromIsr</a> (StreamBuffer_t pxStreamBuffer, uint32_t xBytesSent)</td></tr>
 147 <tr class="memdesc:gaa64809f12f9724d4625dcabe1b9ea563"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer send from ISR when data is successfully copied into the buffer (Op)  <a href="#gaa64809f12f9724d4625dcabe1b9ea563">More...</a><br/></td></tr>
 148 <tr class="separator:gaa64809f12f9724d4625dcabe1b9ea563"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:ga268fb70a2761313c4d402c696c09a563"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga268fb70a2761313c4d402c696c09a563">EvrFreeRTOSStreamBuf_StreamBufferBlockingOnReceive</a> (StreamBuffer_t pxStreamBuffer)</td></tr>
 150 <tr class="memdesc:ga268fb70a2761313c4d402c696c09a563"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer receive when buffer is empty and receiving task is blocked (Op)  <a href="#ga268fb70a2761313c4d402c696c09a563">More...</a><br/></td></tr>
 151 <tr class="separator:ga268fb70a2761313c4d402c696c09a563"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ga5d2b245e399df6f1ea4f973429b6df37"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga5d2b245e399df6f1ea4f973429b6df37">EvrFreeRTOSStreamBuf_StreamBufferReceive</a> (StreamBuffer_t pxStreamBuffer, uint32_t xReceivedLength)</td></tr>
 153 <tr class="memdesc:ga5d2b245e399df6f1ea4f973429b6df37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer receive when data is successfully copied from the buffer (Op)  <a href="#ga5d2b245e399df6f1ea4f973429b6df37">More...</a><br/></td></tr>
 154 <tr class="separator:ga5d2b245e399df6f1ea4f973429b6df37"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:gae0fdb99af8ee80c4175cd4254bf22b36"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#gae0fdb99af8ee80c4175cd4254bf22b36">EvrFreeRTOSStreamBuf_StreamBufferReceiveFailed</a> (StreamBuffer_t pxStreamBuffer)</td></tr>
 156 <tr class="memdesc:gae0fdb99af8ee80c4175cd4254bf22b36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer receive when data is not copied from the buffer (Error)  <a href="#gae0fdb99af8ee80c4175cd4254bf22b36">More...</a><br/></td></tr>
 157 <tr class="separator:gae0fdb99af8ee80c4175cd4254bf22b36"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:ga7f0da3f92c3c1a907f9dab1b7a5d1e28"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__streambuf.html#ga7f0da3f92c3c1a907f9dab1b7a5d1e28">EvrFreeRTOSStreamBuf_StreamBufferReceiveFromIsr</a> (StreamBuffer_t pxStreamBuffer, uint32_t xReceivedLength)</td></tr>
 159 <tr class="memdesc:ga7f0da3f92c3c1a907f9dab1b7a5d1e28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on stream buffer receive from ISR when data is successfully copied from the buffer (Op)  <a href="#ga7f0da3f92c3c1a907f9dab1b7a5d1e28">More...</a><br/></td></tr>
 160 <tr class="separator:ga7f0da3f92c3c1a907f9dab1b7a5d1e28"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 </table>
 162 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 163 <h2 class="groupheader">Function Documentation</h2>
 164 <a class="anchor" id="ga268fb70a2761313c4d402c696c09a563"></a>
 165 <div class="memitem">
 166 <div class="memproto">
 167       <table class="memname">
 168         <tr>
 169           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferBlockingOnReceive </td>
 170           <td>(</td>
 171           <td class="paramtype">StreamBuffer_t&#160;</td>
 172           <td class="paramname"><em>pxStreamBuffer</em></td><td>)</td>
 173           <td></td>
 174         </tr>
 175       </table>
 176 </div><div class="memdoc">
 177 <dl class="params"><dt>Parameters</dt><dd>
 178   <table class="params">
 179     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle.</td></tr>
 180   </table>
 181   </dd>
 182 </dl>
 183 <p>The event <b>StreamBufferBlockingOnReceive</b> is generated when Stream Buffer receive is blocked to wait for data to be available.</p>
 184 <p><b>Value</b> in the Event Recorder shows:</p>
 185 <ul>
 186 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle. </li>
 187 </ul>
 188
 189 </div>
 190 </div>
 191 <a class="anchor" id="ga12f2a913902bcea879c6705cef7d3f2f"></a>
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferBlockingOnSend </td>
 197           <td>(</td>
 198           <td class="paramtype">StreamBuffer_t&#160;</td>
 199           <td class="paramname"><em>pxStreamBuffer</em></td><td>)</td>
 200           <td></td>
 201         </tr>
 202       </table>
 203 </div><div class="memdoc">
 204 <dl class="params"><dt>Parameters</dt><dd>
 205   <table class="params">
 206     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle.</td></tr>
 207   </table>
 208   </dd>
 209 </dl>
 210 <p>The event <b>StreamBufferBlockingOnSend</b> is generated when Stream Buffer send is blocked to wait for free space in the buffer.</p>
 211 <p><b>Value</b> in the Event Recorder shows:</p>
 212 <ul>
 213 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle. </li>
 214 </ul>
 215
 216 </div>
 217 </div>
 218 <a class="anchor" id="gaeba2d793e2e75861beed404403c9bfab"></a>
 219 <div class="memitem">
 220 <div class="memproto">
 221       <table class="memname">
 222         <tr>
 223           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferCreate </td>
 224           <td>(</td>
 225           <td class="paramtype">StreamBuffer_t&#160;</td>
 226           <td class="paramname"><em>pxStreamBuffer</em>, </td>
 227         </tr>
 228         <tr>
 229           <td class="paramkey"></td>
 230           <td></td>
 231           <td class="paramtype">uint32_t&#160;</td>
 232           <td class="paramname"><em>uxIsMessageBuffer</em>&#160;</td>
 233         </tr>
 234         <tr>
 235           <td></td>
 236           <td>)</td>
 237           <td></td><td></td>
 238         </tr>
 239       </table>
 240 </div><div class="memdoc">
 241 <dl class="params"><dt>Parameters</dt><dd>
 242   <table class="params">
 243     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle. </td></tr>
 244     <tr><td class="paramdir">[in]</td><td class="paramname">uxIsMessageBuffer</td><td>buffer type designator (0:stream, 1:message).</td></tr>
 245   </table>
 246   </dd>
 247 </dl>
 248 <p>The event <b>StreamBufferCreate</b> is generated when Stream Buffer object was successfully created.</p>
 249 <p><b>Value</b> in the Event Recorder shows:</p>
 250 <ul>
 251 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle.</li>
 252 <li><b>uxIsMessageBuffer</b> : buffer type designator, 0 for stream buffer and 1 for message buffer. </li>
 253 </ul>
 254
 255 </div>
 256 </div>
 257 <a class="anchor" id="ga7a0a423c5e8c5d461c4e4e3a490b3d35"></a>
 258 <div class="memitem">
 259 <div class="memproto">
 260       <table class="memname">
 261         <tr>
 262           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferCreateFailed </td>
 263           <td>(</td>
 264           <td class="paramtype">uint32_t&#160;</td>
 265           <td class="paramname"><em>uxIsMessageBuffer</em></td><td>)</td>
 266           <td></td>
 267         </tr>
 268       </table>
 269 </div><div class="memdoc">
 270 <dl class="params"><dt>Parameters</dt><dd>
 271   <table class="params">
 272     <tr><td class="paramdir">[in]</td><td class="paramname">uxIsMessageBuffer</td><td>buffer type designator (0:stream, 1:message).</td></tr>
 273   </table>
 274   </dd>
 275 </dl>
 276 <p>The event <b>StreamBufferCreateFailed</b> is generated when Stream Buffer or Message Buffer object create fails due to insufficient heap memory.</p>
 277 <p><b>Value</b> in the Event Recorder shows:</p>
 278 <ul>
 279 <li><b>uxIsMessageBuffer</b> : buffer type designator, 0 for stream buffer and 1 for message buffer. </li>
 280 </ul>
 281
 282 </div>
 283 </div>
 284 <a class="anchor" id="ga5ea642b6e42e189d987fe43997292136"></a>
 285 <div class="memitem">
 286 <div class="memproto">
 287       <table class="memname">
 288         <tr>
 289           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferCreateStaticFailed </td>
 290           <td>(</td>
 291           <td class="paramtype">StreamBuffer_t&#160;</td>
 292           <td class="paramname"><em>pxStreamBuffer</em>, </td>
 293         </tr>
 294         <tr>
 295           <td class="paramkey"></td>
 296           <td></td>
 297           <td class="paramtype">uint32_t&#160;</td>
 298           <td class="paramname"><em>uxIsMessageBuffer</em>&#160;</td>
 299         </tr>
 300         <tr>
 301           <td></td>
 302           <td>)</td>
 303           <td></td><td></td>
 304         </tr>
 305       </table>
 306 </div><div class="memdoc">
 307 <dl class="params"><dt>Parameters</dt><dd>
 308   <table class="params">
 309     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle. </td></tr>
 310     <tr><td class="paramdir">[in]</td><td class="paramname">uxIsMessageBuffer</td><td>buffer type designator (0:stream, 1:message).</td></tr>
 311   </table>
 312   </dd>
 313 </dl>
 314 <p>The event <b>StreamBufferCreateStaticFailed</b> is generated when statically allocated Stream Buffer or Message Buffer object fails to initialize.</p>
 315 <p><b>Value</b> in the Event Recorder shows:</p>
 316 <ul>
 317 <li><b>pxStreamBuffer</b> : pointer to statically allocated Stream Buffer object handle.</li>
 318 <li><b>uxIsMessageBuffer</b> : buffer type designator, 0 for stream buffer and 1 for message buffer. </li>
 319 </ul>
 320
 321 </div>
 322 </div>
 323 <a class="anchor" id="gabe9809fda02bbda1da38919a71a91d8f"></a>
 324 <div class="memitem">
 325 <div class="memproto">
 326       <table class="memname">
 327         <tr>
 328           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferDelete </td>
 329           <td>(</td>
 330           <td class="paramtype">StreamBuffer_t&#160;</td>
 331           <td class="paramname"><em>pxStreamBuffer</em></td><td>)</td>
 332           <td></td>
 333         </tr>
 334       </table>
 335 </div><div class="memdoc">
 336 <dl class="params"><dt>Parameters</dt><dd>
 337   <table class="params">
 338     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle.</td></tr>
 339   </table>
 340   </dd>
 341 </dl>
 342 <p>The event <b>StreamBufferDelete</b> is generated when Stream Buffer object is deallocated or cleared in case of static allocation.</p>
 343 <p><b>Value</b> in the Event Recorder shows:</p>
 344 <ul>
 345 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle. </li>
 346 </ul>
 347
 348 </div>
 349 </div>
 350 <a class="anchor" id="ga5d2b245e399df6f1ea4f973429b6df37"></a>
 351 <div class="memitem">
 352 <div class="memproto">
 353       <table class="memname">
 354         <tr>
 355           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferReceive </td>
 356           <td>(</td>
 357           <td class="paramtype">StreamBuffer_t&#160;</td>
 358           <td class="paramname"><em>pxStreamBuffer</em>, </td>
 359         </tr>
 360         <tr>
 361           <td class="paramkey"></td>
 362           <td></td>
 363           <td class="paramtype">uint32_t&#160;</td>
 364           <td class="paramname"><em>xReceivedLength</em>&#160;</td>
 365         </tr>
 366         <tr>
 367           <td></td>
 368           <td>)</td>
 369           <td></td><td></td>
 370         </tr>
 371       </table>
 372 </div><div class="memdoc">
 373 <dl class="params"><dt>Parameters</dt><dd>
 374   <table class="params">
 375     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle. </td></tr>
 376     <tr><td class="paramdir">[in]</td><td class="paramname">xReceivedLength</td><td>number of bytes copied from the buffer</td></tr>
 377   </table>
 378   </dd>
 379 </dl>
 380 <p>The event <b>StreamBufferReceive</b> is generated when Stream Buffer receive is called.</p>
 381 <p><b>Value</b> in the Event Recorder shows:</p>
 382 <ul>
 383 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle.</li>
 384 <li><b>xReceivedLength</b> : number of bytes copied from the stream buffer </li>
 385 </ul>
 386
 387 </div>
 388 </div>
 389 <a class="anchor" id="gae0fdb99af8ee80c4175cd4254bf22b36"></a>
 390 <div class="memitem">
 391 <div class="memproto">
 392       <table class="memname">
 393         <tr>
 394           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferReceiveFailed </td>
 395           <td>(</td>
 396           <td class="paramtype">StreamBuffer_t&#160;</td>
 397           <td class="paramname"><em>pxStreamBuffer</em></td><td>)</td>
 398           <td></td>
 399         </tr>
 400       </table>
 401 </div><div class="memdoc">
 402 <dl class="params"><dt>Parameters</dt><dd>
 403   <table class="params">
 404     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle.</td></tr>
 405   </table>
 406   </dd>
 407 </dl>
 408 <p>The event <b>StreamBufferReceiveFailed</b> is generated when Stream Buffer receive is called and there is no data to receive.</p>
 409 <p><b>Value</b> in the Event Recorder shows:</p>
 410 <ul>
 411 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle. </li>
 412 </ul>
 413
 414 </div>
 415 </div>
 416 <a class="anchor" id="ga7f0da3f92c3c1a907f9dab1b7a5d1e28"></a>
 417 <div class="memitem">
 418 <div class="memproto">
 419       <table class="memname">
 420         <tr>
 421           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferReceiveFromIsr </td>
 422           <td>(</td>
 423           <td class="paramtype">StreamBuffer_t&#160;</td>
 424           <td class="paramname"><em>pxStreamBuffer</em>, </td>
 425         </tr>
 426         <tr>
 427           <td class="paramkey"></td>
 428           <td></td>
 429           <td class="paramtype">uint32_t&#160;</td>
 430           <td class="paramname"><em>xReceivedLength</em>&#160;</td>
 431         </tr>
 432         <tr>
 433           <td></td>
 434           <td>)</td>
 435           <td></td><td></td>
 436         </tr>
 437       </table>
 438 </div><div class="memdoc">
 439 <dl class="params"><dt>Parameters</dt><dd>
 440   <table class="params">
 441     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle. </td></tr>
 442     <tr><td class="paramdir">[in]</td><td class="paramname">xReceivedLength</td><td>number of bytes copied from the buffer</td></tr>
 443   </table>
 444   </dd>
 445 </dl>
 446 <p>The event <b>StreamBufferReceiveFromIsr</b> is generated when Stream Buffer receive is called from the ISR.</p>
 447 <p><b>Value</b> in the Event Recorder shows:</p>
 448 <ul>
 449 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle.</li>
 450 <li><b>xReceivedLength</b> : number of bytes copied from the stream buffer </li>
 451 </ul>
 452
 453 </div>
 454 </div>
 455 <a class="anchor" id="ga3151e5298becca4377d20cea96eb4dd1"></a>
 456 <div class="memitem">
 457 <div class="memproto">
 458       <table class="memname">
 459         <tr>
 460           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferReset </td>
 461           <td>(</td>
 462           <td class="paramtype">StreamBuffer_t&#160;</td>
 463           <td class="paramname"><em>pxStreamBuffer</em></td><td>)</td>
 464           <td></td>
 465         </tr>
 466       </table>
 467 </div><div class="memdoc">
 468 <dl class="params"><dt>Parameters</dt><dd>
 469   <table class="params">
 470     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle.</td></tr>
 471   </table>
 472   </dd>
 473 </dl>
 474 <p>The event <b>StreamBufferReset</b> is generated when Stream Buffer object is reset and re-initialized.</p>
 475 <p><b>Value</b> in the Event Recorder shows:</p>
 476 <ul>
 477 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle. </li>
 478 </ul>
 479
 480 </div>
 481 </div>
 482 <a class="anchor" id="ga6393f44cfcef26222c363adf23659e6b"></a>
 483 <div class="memitem">
 484 <div class="memproto">
 485       <table class="memname">
 486         <tr>
 487           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferSend </td>
 488           <td>(</td>
 489           <td class="paramtype">StreamBuffer_t&#160;</td>
 490           <td class="paramname"><em>pxStreamBuffer</em>, </td>
 491         </tr>
 492         <tr>
 493           <td class="paramkey"></td>
 494           <td></td>
 495           <td class="paramtype">uint32_t&#160;</td>
 496           <td class="paramname"><em>xBytesSent</em>&#160;</td>
 497         </tr>
 498         <tr>
 499           <td></td>
 500           <td>)</td>
 501           <td></td><td></td>
 502         </tr>
 503       </table>
 504 </div><div class="memdoc">
 505 <dl class="params"><dt>Parameters</dt><dd>
 506   <table class="params">
 507     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle. </td></tr>
 508     <tr><td class="paramdir">[in]</td><td class="paramname">xBytesSent</td><td>number of bytes copied into the buffer</td></tr>
 509   </table>
 510   </dd>
 511 </dl>
 512 <p>The event <b>StreamBufferSend</b> is generated when Stream Buffer sends the data into the buffer.</p>
 513 <p><b>Value</b> in the Event Recorder shows:</p>
 514 <ul>
 515 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle.</li>
 516 <li><b>xBytesSent</b> : number of bytes copied into the stream buffer </li>
 517 </ul>
 518
 519 </div>
 520 </div>
 521 <a class="anchor" id="ga6cb3b5c034a5dfcc8d7ddbc2aff2a1bc"></a>
 522 <div class="memitem">
 523 <div class="memproto">
 524       <table class="memname">
 525         <tr>
 526           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferSendFailed </td>
 527           <td>(</td>
 528           <td class="paramtype">StreamBuffer_t&#160;</td>
 529           <td class="paramname"><em>pxStreamBuffer</em></td><td>)</td>
 530           <td></td>
 531         </tr>
 532       </table>
 533 </div><div class="memdoc">
 534 <dl class="params"><dt>Parameters</dt><dd>
 535   <table class="params">
 536     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle.</td></tr>
 537   </table>
 538   </dd>
 539 </dl>
 540 <p>The event <b>StreamBufferSendFailed</b> is generated when Stream Buffer failed to send data into the buffer.</p>
 541 <p><b>Value</b> in the Event Recorder shows:</p>
 542 <ul>
 543 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle. </li>
 544 </ul>
 545
 546 </div>
 547 </div>
 548 <a class="anchor" id="gaa64809f12f9724d4625dcabe1b9ea563"></a>
 549 <div class="memitem">
 550 <div class="memproto">
 551       <table class="memname">
 552         <tr>
 553           <td class="memname">void EvrFreeRTOSStreamBuf_StreamBufferSendFromIsr </td>
 554           <td>(</td>
 555           <td class="paramtype">StreamBuffer_t&#160;</td>
 556           <td class="paramname"><em>pxStreamBuffer</em>, </td>
 557         </tr>
 558         <tr>
 559           <td class="paramkey"></td>
 560           <td></td>
 561           <td class="paramtype">uint32_t&#160;</td>
 562           <td class="paramname"><em>xBytesSent</em>&#160;</td>
 563         </tr>
 564         <tr>
 565           <td></td>
 566           <td>)</td>
 567           <td></td><td></td>
 568         </tr>
 569       </table>
 570 </div><div class="memdoc">
 571 <dl class="params"><dt>Parameters</dt><dd>
 572   <table class="params">
 573     <tr><td class="paramdir">[in]</td><td class="paramname">pxStreamBuffer</td><td>pointer to Stream Buffer object handle. </td></tr>
 574     <tr><td class="paramdir">[in]</td><td class="paramname">xBytesSent</td><td>number of bytes copied into the buffer</td></tr>
 575   </table>
 576   </dd>
 577 </dl>
 578 <p>The event <b>StreamBufferSendFromIsr</b> is generated when Stream Buffer send was called from the ISR.</p>
 579 <p><b>Value</b> in the Event Recorder shows:</p>
 580 <ul>
 581 <li><b>pxStreamBuffer</b> : pointer to Stream Buffer object handle.</li>
 582 <li><b>xBytesSent</b> : number of bytes copied into the stream buffer </li>
 583 </ul>
 584
 585 </div>
 586 </div>
 587 </div><!-- contents -->
 588 </div><!-- doc-content -->
 589 <!-- start footer part -->
 590 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 591   <ul>
 592     <li class="footer">Generated on Thu Apr 30 2020 11:16:53 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
 593         <!--
 594     <a href="http://www.doxygen.org/index.html">
 595     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
 596         -->
 597         </li>
 598   </ul>
 599 </div>
 600 </body>
 601 </html>