<!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: message_buffer.h File 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&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&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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('message__buffer_8h.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="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">message_buffer.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="stream__buffer_8h_source.html">stream_buffer.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for message_buffer.h:</div>
<div class="dyncontent">
<div class="center"><img src="message__buffer_8h__incl.png" border="0" usemap="#amessage__buffer_8h" alt=""/></div>
<map name="message__buffer_8h" id="amessage__buffer_8h">
<area shape="rect" title=" " alt="" coords="5,5,132,32"/>
<area shape="rect" href="stream__buffer_8h.html" title=" " alt="" coords="12,80,125,107"/>
</map>
</div>
</div>
<p><a href="message__buffer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a2959cd0e3d2bd20d46908e5c9872be36"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a2959cd0e3d2bd20d46908e5c9872be36">xMessageBufferCreate</a>(xBufferSizeBytes)   ( <a class="el" href="message__buffer_8h.html#ae8442d50f3b62d237c40b02742f0209a">MessageBufferHandle_t</a> ) <a class="el" href="stream__buffer_8h.html#a7a613c6fa11323c871ce7991db214096">xStreamBufferGenericCreate</a>( xBufferSizeBytes, ( size_t ) 0, <a class="el" href="projdefs_8h.html#af268cf937960eb029256bd9c4d949fbe">pdTRUE</a> )</td></tr>
<tr class="separator:a2959cd0e3d2bd20d46908e5c9872be36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc84f4a15dbd39ecbad35f7337e78b2c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#acc84f4a15dbd39ecbad35f7337e78b2c">xMessageBufferCreateStatic</a>(xBufferSizeBytes, pucMessageBufferStorageArea, pxStaticMessageBuffer)   ( <a class="el" href="message__buffer_8h.html#ae8442d50f3b62d237c40b02742f0209a">MessageBufferHandle_t</a> ) <a class="el" href="stream__buffer_8h.html#a1263847a3f77a4f34462df326d78c48c">xStreamBufferGenericCreateStatic</a>( xBufferSizeBytes, 0, <a class="el" href="projdefs_8h.html#af268cf937960eb029256bd9c4d949fbe">pdTRUE</a>, pucMessageBufferStorageArea, pxStaticMessageBuffer )</td></tr>
<tr class="separator:acc84f4a15dbd39ecbad35f7337e78b2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a858f6da6fe24a226c45caf1634ea1605"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a858f6da6fe24a226c45caf1634ea1605">xMessageBufferSend</a>(xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait)   <a class="el" href="stream__buffer_8h.html#a35cdf3b6bf677086b9128782f762499d">xStreamBufferSend</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait )</td></tr>
<tr class="separator:a858f6da6fe24a226c45caf1634ea1605"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeef5b0c4f8c2db6ca2230a8874813e79"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#aeef5b0c4f8c2db6ca2230a8874813e79">xMessageBufferSendFromISR</a>(xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken)   <a class="el" href="stream__buffer_8h.html#a1dab226e99230e01e79bc2b5c0605e44">xStreamBufferSendFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken )</td></tr>
<tr class="separator:aeef5b0c4f8c2db6ca2230a8874813e79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af12a227ba511a95cbea5aa81c7f3ba12"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#af12a227ba511a95cbea5aa81c7f3ba12">xMessageBufferReceive</a>(xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait)   <a class="el" href="stream__buffer_8h.html#a55efc144b988598d84a6087d3e20b507">xStreamBufferReceive</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait )</td></tr>
<tr class="separator:af12a227ba511a95cbea5aa81c7f3ba12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf596c00c44752a3c8c542cc6b5df234"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#adf596c00c44752a3c8c542cc6b5df234">xMessageBufferReceiveFromISR</a>(xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken)   <a class="el" href="stream__buffer_8h.html#a6c882a1d9f26c40f93f271bd1b844b3b">xStreamBufferReceiveFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken )</td></tr>
<tr class="separator:adf596c00c44752a3c8c542cc6b5df234"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa29d6c50600a7b0154e4a47e7c981d1a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#aa29d6c50600a7b0154e4a47e7c981d1a">vMessageBufferDelete</a>(xMessageBuffer)   <a class="el" href="stream__buffer_8h.html#a05dc9d2ae220a050526a062eddf6d7a2">vStreamBufferDelete</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td></tr>
<tr class="separator:aa29d6c50600a7b0154e4a47e7c981d1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60a7e136b74c2a8ce703a99ef636f179"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a60a7e136b74c2a8ce703a99ef636f179">xMessageBufferIsFull</a>(xMessageBuffer)   <a class="el" href="stream__buffer_8h.html#ae393d82ee06e89692248a4381f85dc86">xStreamBufferIsFull</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td></tr>
<tr class="separator:a60a7e136b74c2a8ce703a99ef636f179"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bc30ef43be4bd228d80de1da88c71d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a7bc30ef43be4bd228d80de1da88c71d8">xMessageBufferIsEmpty</a>(xMessageBuffer)   <a class="el" href="stream__buffer_8h.html#af65cd558025ddc29ca68fba1b3f5dc19">xStreamBufferIsEmpty</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td></tr>
<tr class="separator:a7bc30ef43be4bd228d80de1da88c71d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d22ac0fd0463b202f2e22674380a41c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a6d22ac0fd0463b202f2e22674380a41c">xMessageBufferReset</a>(xMessageBuffer)   <a class="el" href="stream__buffer_8h.html#a5253429645c67902c2fc8682f8af0aac">xStreamBufferReset</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td></tr>
<tr class="separator:a6d22ac0fd0463b202f2e22674380a41c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f1e75a283ef603e914e10ae354e5ab8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a9f1e75a283ef603e914e10ae354e5ab8">xMessageBufferSpaceAvailable</a>(xMessageBuffer)   <a class="el" href="stream__buffer_8h.html#a9a78e0206cb1dc343c329f9db579208d">xStreamBufferSpacesAvailable</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td></tr>
<tr class="separator:a9f1e75a283ef603e914e10ae354e5ab8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45918d12bf530cb2b4bf21c0936460a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a45918d12bf530cb2b4bf21c0936460a9">xMessageBufferSendCompletedFromISR</a>(xMessageBuffer, pxHigherPriorityTaskWoken)   <a class="el" href="stream__buffer_8h.html#abc37189e4eb8618f5434ae333dd50b23">xStreamBufferSendCompletedFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pxHigherPriorityTaskWoken )</td></tr>
<tr class="separator:a45918d12bf530cb2b4bf21c0936460a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22b1a37d0d4f39acd87250f73d9aab0c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#a22b1a37d0d4f39acd87250f73d9aab0c">xMessageBufferReceiveCompletedFromISR</a>(xMessageBuffer, pxHigherPriorityTaskWoken)   <a class="el" href="stream__buffer_8h.html#ac12e93e96e0eafbc0e981d00e7275d32">xStreamBufferReceiveCompletedFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pxHigherPriorityTaskWoken )</td></tr>
<tr class="separator:a22b1a37d0d4f39acd87250f73d9aab0c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae8442d50f3b62d237c40b02742f0209a"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="message__buffer_8h.html#ae8442d50f3b62d237c40b02742f0209a">MessageBufferHandle_t</a></td></tr>
<tr class="separator:ae8442d50f3b62d237c40b02742f0209a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa29d6c50600a7b0154e4a47e7c981d1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa29d6c50600a7b0154e4a47e7c981d1a">◆ </a></span>vMessageBufferDelete</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define vMessageBufferDelete</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer</td><td>)</td>
<td>   <a class="el" href="stream__buffer_8h.html#a05dc9d2ae220a050526a062eddf6d7a2">vStreamBufferDelete</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="message__buffer_8h.html">message_buffer.h</a></p>
<pre>
void <a class="el" href="message__buffer_8h.html#aa29d6c50600a7b0154e4a47e7c981d1a">vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer )</a>;
</pre><p>Deletes a message buffer that was previously created using a call to <a class="el" href="message__buffer_8h.html#a2959cd0e3d2bd20d46908e5c9872be36">xMessageBufferCreate()</a> or <a class="el" href="message__buffer_8h.html#acc84f4a15dbd39ecbad35f7337e78b2c">xMessageBufferCreateStatic()</a>. If the message buffer was created using dynamic memory (that is, by <a class="el" href="message__buffer_8h.html#a2959cd0e3d2bd20d46908e5c9872be36">xMessageBufferCreate()</a>), then the allocated memory is freed.</p>
<p>A message buffer handle must not be used after the message buffer has been deleted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xMessageBuffer</td><td>The handle of the message buffer to be deleted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2959cd0e3d2bd20d46908e5c9872be36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2959cd0e3d2bd20d46908e5c9872be36">◆ </a></span>xMessageBufferCreate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferCreate</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xBufferSizeBytes</td><td>)</td>
<td>   ( <a class="el" href="message__buffer_8h.html#ae8442d50f3b62d237c40b02742f0209a">MessageBufferHandle_t</a> ) <a class="el" href="stream__buffer_8h.html#a7a613c6fa11323c871ce7991db214096">xStreamBufferGenericCreate</a>( xBufferSizeBytes, ( size_t ) 0, <a class="el" href="projdefs_8h.html#af268cf937960eb029256bd9c4d949fbe">pdTRUE</a> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acc84f4a15dbd39ecbad35f7337e78b2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc84f4a15dbd39ecbad35f7337e78b2c">◆ </a></span>xMessageBufferCreateStatic</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferCreateStatic</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xBufferSizeBytes, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pucMessageBufferStorageArea, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pxStaticMessageBuffer </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ( <a class="el" href="message__buffer_8h.html#ae8442d50f3b62d237c40b02742f0209a">MessageBufferHandle_t</a> ) <a class="el" href="stream__buffer_8h.html#a1263847a3f77a4f34462df326d78c48c">xStreamBufferGenericCreateStatic</a>( xBufferSizeBytes, 0, <a class="el" href="projdefs_8h.html#af268cf937960eb029256bd9c4d949fbe">pdTRUE</a>, pucMessageBufferStorageArea, pxStaticMessageBuffer )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7bc30ef43be4bd228d80de1da88c71d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bc30ef43be4bd228d80de1da88c71d8">◆ </a></span>xMessageBufferIsEmpty</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferIsEmpty</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer</td><td>)</td>
<td>   <a class="el" href="stream__buffer_8h.html#af65cd558025ddc29ca68fba1b3f5dc19">xStreamBufferIsEmpty</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="message__buffer_8h.html">message_buffer.h</a> </p><pre>
BaseType_t <a class="el" href="message__buffer_8h.html#a7bc30ef43be4bd228d80de1da88c71d8">xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer )</a> );
</pre><p>Tests to see if a message buffer is empty (does not contain any messages).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xMessageBuffer</td><td>The handle of the message buffer being queried.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the message buffer referenced by xMessageBuffer is empty then pdTRUE is returned. Otherwise pdFALSE is returned. </dd></dl>
</div>
</div>
<a id="a60a7e136b74c2a8ce703a99ef636f179"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60a7e136b74c2a8ce703a99ef636f179">◆ </a></span>xMessageBufferIsFull</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferIsFull</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer</td><td>)</td>
<td>   <a class="el" href="stream__buffer_8h.html#ae393d82ee06e89692248a4381f85dc86">xStreamBufferIsFull</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="message__buffer_8h.html">message_buffer.h</a> </p><pre>
BaseType_t <a class="el" href="message__buffer_8h.html#a60a7e136b74c2a8ce703a99ef636f179">xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer )</a> );
</pre><p>Tests to see if a message buffer is full. A message buffer is full if it cannot accept any more messages, of any size, until space is made available by a message being removed from the message buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xMessageBuffer</td><td>The handle of the message buffer being queried.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the message buffer referenced by xMessageBuffer is full then pdTRUE is returned. Otherwise pdFALSE is returned. </dd></dl>
</div>
</div>
<a id="af12a227ba511a95cbea5aa81c7f3ba12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af12a227ba511a95cbea5aa81c7f3ba12">◆ </a></span>xMessageBufferReceive</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferReceive</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pvRxData, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">xBufferLengthBytes, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">xTicksToWait </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="stream__buffer_8h.html#a55efc144b988598d84a6087d3e20b507">xStreamBufferReceive</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a22b1a37d0d4f39acd87250f73d9aab0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22b1a37d0d4f39acd87250f73d9aab0c">◆ </a></span>xMessageBufferReceiveCompletedFromISR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferReceiveCompletedFromISR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pxHigherPriorityTaskWoken </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="stream__buffer_8h.html#ac12e93e96e0eafbc0e981d00e7275d32">xStreamBufferReceiveCompletedFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pxHigherPriorityTaskWoken )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adf596c00c44752a3c8c542cc6b5df234"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf596c00c44752a3c8c542cc6b5df234">◆ </a></span>xMessageBufferReceiveFromISR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferReceiveFromISR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pvRxData, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">xBufferLengthBytes, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pxHigherPriorityTaskWoken </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="stream__buffer_8h.html#a6c882a1d9f26c40f93f271bd1b844b3b">xStreamBufferReceiveFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6d22ac0fd0463b202f2e22674380a41c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d22ac0fd0463b202f2e22674380a41c">◆ </a></span>xMessageBufferReset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferReset</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer</td><td>)</td>
<td>   <a class="el" href="stream__buffer_8h.html#a5253429645c67902c2fc8682f8af0aac">xStreamBufferReset</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a858f6da6fe24a226c45caf1634ea1605"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a858f6da6fe24a226c45caf1634ea1605">◆ </a></span>xMessageBufferSend</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferSend</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pvTxData, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">xDataLengthBytes, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">xTicksToWait </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="stream__buffer_8h.html#a35cdf3b6bf677086b9128782f762499d">xStreamBufferSend</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a45918d12bf530cb2b4bf21c0936460a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45918d12bf530cb2b4bf21c0936460a9">◆ </a></span>xMessageBufferSendCompletedFromISR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferSendCompletedFromISR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pxHigherPriorityTaskWoken </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="stream__buffer_8h.html#abc37189e4eb8618f5434ae333dd50b23">xStreamBufferSendCompletedFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pxHigherPriorityTaskWoken )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aeef5b0c4f8c2db6ca2230a8874813e79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeef5b0c4f8c2db6ca2230a8874813e79">◆ </a></span>xMessageBufferSendFromISR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferSendFromISR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pvTxData, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">xDataLengthBytes, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pxHigherPriorityTaskWoken </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="stream__buffer_8h.html#a1dab226e99230e01e79bc2b5c0605e44">xStreamBufferSendFromISR</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9f1e75a283ef603e914e10ae354e5ab8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f1e75a283ef603e914e10ae354e5ab8">◆ </a></span>xMessageBufferSpaceAvailable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define xMessageBufferSpaceAvailable</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">xMessageBuffer</td><td>)</td>
<td>   <a class="el" href="stream__buffer_8h.html#a9a78e0206cb1dc343c329f9db579208d">xStreamBufferSpacesAvailable</a>( ( <a class="el" href="stream__buffer_8h.html#a023fdaf7aa7415dc027147e223c0f710">StreamBufferHandle_t</a> ) xMessageBuffer )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ae8442d50f3b62d237c40b02742f0209a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8442d50f3b62d237c40b02742f0209a">◆ </a></span>MessageBufferHandle_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="message__buffer_8h.html#ae8442d50f3b62d237c40b02742f0209a">MessageBufferHandle_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type by which message buffers are referenced. For example, a call to <a class="el" href="message__buffer_8h.html#a2959cd0e3d2bd20d46908e5c9872be36">xMessageBufferCreate()</a> returns an MessageBufferHandle_t variable that can then be used as a parameter to <a class="el" href="message__buffer_8h.html#a858f6da6fe24a226c45caf1634ea1605">xMessageBufferSend()</a>, <a class="el" href="message__buffer_8h.html#af12a227ba511a95cbea5aa81c7f3ba12">xMessageBufferReceive()</a>, etc. </p>
</div>
</div>
</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="message__buffer_8h.html">message_buffer.h</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>