begriffs open source - cmsis-freertos/blob - v11.1.0/group__freertos__evr__streambuf.html

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