]> begriffs open source - cmsis-freertos/blob - docs/General/html/group__freertos__evr__queue.html
Updated documentation for release.
[cmsis-freertos] / docs / General / html / group__freertos__evr__queue.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>Message Queue Functions</title>
7 <title>CMSIS-FreeRTOS: Message Queue 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 9.1.0</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__queue.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">Message Queue 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 message queue 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:gaf65ca7e52be7c04919cd73c9e0927c44"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gaf65ca7e52be7c04919cd73c9e0927c44">EvrFreeRTOSQueue_QueueCreate</a> (Queue_t pxQueue)</td></tr>
123 <tr class="memdesc:gaf65ca7e52be7c04919cd73c9e0927c44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful queue create (Op)  <a href="#gaf65ca7e52be7c04919cd73c9e0927c44">More...</a><br/></td></tr>
124 <tr class="separator:gaf65ca7e52be7c04919cd73c9e0927c44"><td class="memSeparator" colspan="2">&#160;</td></tr>
125 <tr class="memitem:ga9835b0034b54ff700734ce8d96a8884e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga9835b0034b54ff700734ce8d96a8884e">EvrFreeRTOSQueue_QueueCreateFailed</a> (uint32_t ucQueueType)</td></tr>
126 <tr class="memdesc:ga9835b0034b54ff700734ce8d96a8884e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful queue create (Error)  <a href="#ga9835b0034b54ff700734ce8d96a8884e">More...</a><br/></td></tr>
127 <tr class="separator:ga9835b0034b54ff700734ce8d96a8884e"><td class="memSeparator" colspan="2">&#160;</td></tr>
128 <tr class="memitem:gae20f59e74e83d37657e9950539337c0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gae20f59e74e83d37657e9950539337c0c">EvrFreeRTOSQueue_CreateMutex</a> (Queue_t pxNewQueue)</td></tr>
129 <tr class="memdesc:gae20f59e74e83d37657e9950539337c0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful mutex create (Op)  <a href="#gae20f59e74e83d37657e9950539337c0c">More...</a><br/></td></tr>
130 <tr class="separator:gae20f59e74e83d37657e9950539337c0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 <tr class="memitem:ga3ec552a8f0ca9630804405e6c46f75ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga3ec552a8f0ca9630804405e6c46f75ab">EvrFreeRTOSQueue_CreateMutexFailed</a> (void)</td></tr>
132 <tr class="memdesc:ga3ec552a8f0ca9630804405e6c46f75ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful mutex create (Error)  <a href="#ga3ec552a8f0ca9630804405e6c46f75ab">More...</a><br/></td></tr>
133 <tr class="separator:ga3ec552a8f0ca9630804405e6c46f75ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
134 <tr class="memitem:ga685d7646105897c13f096fb26257e18b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga685d7646105897c13f096fb26257e18b">EvrFreeRTOSQueue_GiveMutexRecursive</a> (Queue_t pxMutex)</td></tr>
135 <tr class="memdesc:ga685d7646105897c13f096fb26257e18b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful recursive mutex give (Op)  <a href="#ga685d7646105897c13f096fb26257e18b">More...</a><br/></td></tr>
136 <tr class="separator:ga685d7646105897c13f096fb26257e18b"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <tr class="memitem:ga133bfa4aa98cec148bbcfe7e966fd3c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga133bfa4aa98cec148bbcfe7e966fd3c8">EvrFreeRTOSQueue_GiveMutexRecursiveFailed</a> (Queue_t pxMutex)</td></tr>
138 <tr class="memdesc:ga133bfa4aa98cec148bbcfe7e966fd3c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful recursive mutex give (Error)  <a href="#ga133bfa4aa98cec148bbcfe7e966fd3c8">More...</a><br/></td></tr>
139 <tr class="separator:ga133bfa4aa98cec148bbcfe7e966fd3c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:gae523dab25c47359f13267aa5f1496a6e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gae523dab25c47359f13267aa5f1496a6e">EvrFreeRTOSQueue_TakeMutexRecursive</a> (Queue_t pxMutex)</td></tr>
141 <tr class="memdesc:gae523dab25c47359f13267aa5f1496a6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful recursive mutex take (Op)  <a href="#gae523dab25c47359f13267aa5f1496a6e">More...</a><br/></td></tr>
142 <tr class="separator:gae523dab25c47359f13267aa5f1496a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:gaf0e44408b746e8fa9c2ae43494717eb0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gaf0e44408b746e8fa9c2ae43494717eb0">EvrFreeRTOSQueue_TakeMutexRecursiveFailed</a> (Queue_t pxMutex)</td></tr>
144 <tr class="memdesc:gaf0e44408b746e8fa9c2ae43494717eb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful recursive mutex take (Error)  <a href="#gaf0e44408b746e8fa9c2ae43494717eb0">More...</a><br/></td></tr>
145 <tr class="separator:gaf0e44408b746e8fa9c2ae43494717eb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:ga22c8b04accdd44433697e8b848bed22b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga22c8b04accdd44433697e8b848bed22b">EvrFreeRTOSQueue_CreateCountingSemaphore</a> (Queue_t xHandle)</td></tr>
147 <tr class="memdesc:ga22c8b04accdd44433697e8b848bed22b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful counting semaphore create (Op)  <a href="#ga22c8b04accdd44433697e8b848bed22b">More...</a><br/></td></tr>
148 <tr class="separator:ga22c8b04accdd44433697e8b848bed22b"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:gab5329701b85d1d3a0142f2a1817936f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gab5329701b85d1d3a0142f2a1817936f6">EvrFreeRTOSQueue_CreateCountingSemaphoreFailed</a> (void)</td></tr>
150 <tr class="memdesc:gab5329701b85d1d3a0142f2a1817936f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful counting semaphore create (Error)  <a href="#gab5329701b85d1d3a0142f2a1817936f6">More...</a><br/></td></tr>
151 <tr class="separator:gab5329701b85d1d3a0142f2a1817936f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:ga107ec0fa12e1cc88f50be0cd0531ceb0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga107ec0fa12e1cc88f50be0cd0531ceb0">EvrFreeRTOSQueue_QueueSend</a> (Queue_t pxQueue)</td></tr>
153 <tr class="memdesc:ga107ec0fa12e1cc88f50be0cd0531ceb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on queue write (Op)  <a href="#ga107ec0fa12e1cc88f50be0cd0531ceb0">More...</a><br/></td></tr>
154 <tr class="separator:ga107ec0fa12e1cc88f50be0cd0531ceb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:ga9b5109c8b791ec28631d98e28649ca7d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga9b5109c8b791ec28631d98e28649ca7d">EvrFreeRTOSQueue_QueueSendFailed</a> (Queue_t pxQueue)</td></tr>
156 <tr class="memdesc:ga9b5109c8b791ec28631d98e28649ca7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on write to the full queue (Error)  <a href="#ga9b5109c8b791ec28631d98e28649ca7d">More...</a><br/></td></tr>
157 <tr class="separator:ga9b5109c8b791ec28631d98e28649ca7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:gaa808374145d4e6c9b15573a6d4f10b44"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gaa808374145d4e6c9b15573a6d4f10b44">EvrFreeRTOSQueue_QueueReceive</a> (Queue_t pxQueue)</td></tr>
159 <tr class="memdesc:gaa808374145d4e6c9b15573a6d4f10b44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on queue read (Op)  <a href="#gaa808374145d4e6c9b15573a6d4f10b44">More...</a><br/></td></tr>
160 <tr class="separator:gaa808374145d4e6c9b15573a6d4f10b44"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="memitem:gaa3bc9dbb9e5c5deab9fed12cd2cb627f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gaa3bc9dbb9e5c5deab9fed12cd2cb627f">EvrFreeRTOSQueue_QueuePeek</a> (Queue_t pxQueue)</td></tr>
162 <tr class="memdesc:gaa3bc9dbb9e5c5deab9fed12cd2cb627f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on queue peek (Op)  <a href="#gaa3bc9dbb9e5c5deab9fed12cd2cb627f">More...</a><br/></td></tr>
163 <tr class="separator:gaa3bc9dbb9e5c5deab9fed12cd2cb627f"><td class="memSeparator" colspan="2">&#160;</td></tr>
164 <tr class="memitem:ga3a76836bcf6f9a82a8b0c7d7166185af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga3a76836bcf6f9a82a8b0c7d7166185af">EvrFreeRTOSQueue_QueuePeekFromIsr</a> (Queue_t pxQueue)</td></tr>
165 <tr class="memdesc:ga3a76836bcf6f9a82a8b0c7d7166185af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on queue peek from ISR (Op)  <a href="#ga3a76836bcf6f9a82a8b0c7d7166185af">More...</a><br/></td></tr>
166 <tr class="separator:ga3a76836bcf6f9a82a8b0c7d7166185af"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <tr class="memitem:ga18237d199bd932452e23b75b317b45f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga18237d199bd932452e23b75b317b45f0">EvrFreeRTOSQueue_QueueReceiveFailed</a> (Queue_t pxQueue)</td></tr>
168 <tr class="memdesc:ga18237d199bd932452e23b75b317b45f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on read from the empty queue (Error)  <a href="#ga18237d199bd932452e23b75b317b45f0">More...</a><br/></td></tr>
169 <tr class="separator:ga18237d199bd932452e23b75b317b45f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <tr class="memitem:ga0308f241666bc80e9ff3357b701aed27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga0308f241666bc80e9ff3357b701aed27">EvrFreeRTOSQueue_QueueSendFromIsr</a> (Queue_t pxQueue)</td></tr>
171 <tr class="memdesc:ga0308f241666bc80e9ff3357b701aed27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on write to the queue from ISR (Op)  <a href="#ga0308f241666bc80e9ff3357b701aed27">More...</a><br/></td></tr>
172 <tr class="separator:ga0308f241666bc80e9ff3357b701aed27"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <tr class="memitem:gabcbc7ca489384b8fc4cf6d88a0819960"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gabcbc7ca489384b8fc4cf6d88a0819960">EvrFreeRTOSQueue_QueueSendFromIsrFailed</a> (Queue_t pxQueue)</td></tr>
174 <tr class="memdesc:gabcbc7ca489384b8fc4cf6d88a0819960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on write to the full queue from ISR (Error)  <a href="#gabcbc7ca489384b8fc4cf6d88a0819960">More...</a><br/></td></tr>
175 <tr class="separator:gabcbc7ca489384b8fc4cf6d88a0819960"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <tr class="memitem:ga8e31694e053094dd88fecf7fc0fa764e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga8e31694e053094dd88fecf7fc0fa764e">EvrFreeRTOSQueue_QueueReceiveFromIsr</a> (Queue_t pxQueue)</td></tr>
177 <tr class="memdesc:ga8e31694e053094dd88fecf7fc0fa764e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on queue read from ISR (Op)  <a href="#ga8e31694e053094dd88fecf7fc0fa764e">More...</a><br/></td></tr>
178 <tr class="separator:ga8e31694e053094dd88fecf7fc0fa764e"><td class="memSeparator" colspan="2">&#160;</td></tr>
179 <tr class="memitem:ga2fbc27227935a83ab5b90e78f5dd617e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga2fbc27227935a83ab5b90e78f5dd617e">EvrFreeRTOSQueue_QueueReceiveFromIsrFailed</a> (Queue_t pxQueue)</td></tr>
180 <tr class="memdesc:ga2fbc27227935a83ab5b90e78f5dd617e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on empty queue read from ISR (Error)  <a href="#ga2fbc27227935a83ab5b90e78f5dd617e">More...</a><br/></td></tr>
181 <tr class="separator:ga2fbc27227935a83ab5b90e78f5dd617e"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 <tr class="memitem:ga6a0c0cfd4c954e66867adcdee0d595d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga6a0c0cfd4c954e66867adcdee0d595d8">EvrFreeRTOSQueue_QueuePeekFromIsrFailed</a> (Queue_t pxQueue)</td></tr>
183 <tr class="memdesc:ga6a0c0cfd4c954e66867adcdee0d595d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on empty queue peek from ISR (Error)  <a href="#ga6a0c0cfd4c954e66867adcdee0d595d8">More...</a><br/></td></tr>
184 <tr class="separator:ga6a0c0cfd4c954e66867adcdee0d595d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
185 <tr class="memitem:gade932b1d4bfc68a5c023e94e0506ca6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#gade932b1d4bfc68a5c023e94e0506ca6a">EvrFreeRTOSQueue_QueueDelete</a> (Queue_t pxQueue)</td></tr>
186 <tr class="memdesc:gade932b1d4bfc68a5c023e94e0506ca6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on queue delete (Op)  <a href="#gade932b1d4bfc68a5c023e94e0506ca6a">More...</a><br/></td></tr>
187 <tr class="separator:gade932b1d4bfc68a5c023e94e0506ca6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
188 <tr class="memitem:ga9a8c0960e13c7ba48e9416e2b17ce0fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga9a8c0960e13c7ba48e9416e2b17ce0fc">EvrFreeRTOSQueue_QueueRegistryAdd</a> (Queue_t pxQueue, const char *pcQueueName)</td></tr>
189 <tr class="memdesc:ga9a8c0960e13c7ba48e9416e2b17ce0fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on assignment of a human readable name to a queue (Op)  <a href="#ga9a8c0960e13c7ba48e9416e2b17ce0fc">More...</a><br/></td></tr>
190 <tr class="separator:ga9a8c0960e13c7ba48e9416e2b17ce0fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
191 <tr class="memitem:ga77583e9fe3689604c6468d7f50c6f8bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga77583e9fe3689604c6468d7f50c6f8bb">EvrFreeRTOSQueue_BlockingOnQueueReceive</a> (Queue_t pxQueue)</td></tr>
192 <tr class="memdesc:ga77583e9fe3689604c6468d7f50c6f8bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event indicating the current running task is about to block while reading from an empty queue (Op)  <a href="#ga77583e9fe3689604c6468d7f50c6f8bb">More...</a><br/></td></tr>
193 <tr class="separator:ga77583e9fe3689604c6468d7f50c6f8bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
194 <tr class="memitem:ga994e678a0194fa2d2862c8d5ff165e98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__freertos__evr__queue.html#ga994e678a0194fa2d2862c8d5ff165e98">EvrFreeRTOSQueue_BlockingOnQueueSend</a> (Queue_t pxQueue)</td></tr>
195 <tr class="memdesc:ga994e678a0194fa2d2862c8d5ff165e98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event indicating the current running task is about to block while writting to a full queue (Op)  <a href="#ga994e678a0194fa2d2862c8d5ff165e98">More...</a><br/></td></tr>
196 <tr class="separator:ga994e678a0194fa2d2862c8d5ff165e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
197 </table>
198 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
199 <h2 class="groupheader">Function Documentation</h2>
200 <a class="anchor" id="ga77583e9fe3689604c6468d7f50c6f8bb"></a>
201 <div class="memitem">
202 <div class="memproto">
203       <table class="memname">
204         <tr>
205           <td class="memname">void EvrFreeRTOSQueue_BlockingOnQueueReceive </td>
206           <td>(</td>
207           <td class="paramtype">Queue_t&#160;</td>
208           <td class="paramname"><em>pxQueue</em></td><td>)</td>
209           <td></td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213 <dl class="params"><dt>Parameters</dt><dd>
214   <table class="params">
215     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
216   </table>
217   </dd>
218 </dl>
219 <p>The event <b>BlockingOnQueueReceive</b> is generated when the currently executing task is about to block following an attempt to read from an empty queue, or an attempt to 'take' an empty semaphore or mutex.</p>
220 <p><b>Value</b> in the Event Recorder shows:</p>
221 <ul>
222 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
223 </ul>
224
225 </div>
226 </div>
227 <a class="anchor" id="ga994e678a0194fa2d2862c8d5ff165e98"></a>
228 <div class="memitem">
229 <div class="memproto">
230       <table class="memname">
231         <tr>
232           <td class="memname">void EvrFreeRTOSQueue_BlockingOnQueueSend </td>
233           <td>(</td>
234           <td class="paramtype">Queue_t&#160;</td>
235           <td class="paramname"><em>pxQueue</em></td><td>)</td>
236           <td></td>
237         </tr>
238       </table>
239 </div><div class="memdoc">
240 <dl class="params"><dt>Parameters</dt><dd>
241   <table class="params">
242     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
243   </table>
244   </dd>
245 </dl>
246 <p>The event <b>BlockingOnQueueSend</b> is generated when the currently executing task is about to block following an attempt to write to a full queue.</p>
247 <p><b>Value</b> in the Event Recorder shows:</p>
248 <ul>
249 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
250 </ul>
251
252 </div>
253 </div>
254 <a class="anchor" id="ga22c8b04accdd44433697e8b848bed22b"></a>
255 <div class="memitem">
256 <div class="memproto">
257       <table class="memname">
258         <tr>
259           <td class="memname">void EvrFreeRTOSQueue_CreateCountingSemaphore </td>
260           <td>(</td>
261           <td class="paramtype">Queue_t&#160;</td>
262           <td class="paramname"><em>xHandle</em></td><td>)</td>
263           <td></td>
264         </tr>
265       </table>
266 </div><div class="memdoc">
267 <dl class="params"><dt>Parameters</dt><dd>
268   <table class="params">
269     <tr><td class="paramdir">[in]</td><td class="paramname">xHandle</td><td>pointer to semaphore object handle.</td></tr>
270   </table>
271   </dd>
272 </dl>
273 <p>The event <b>CreateCountingSemaphore</b> is generated when counting semaphore object is successfully created.</p>
274 <p><b>Value</b> in the Event Recorder shows:</p>
275 <ul>
276 <li><b>xHandle</b> : pointer to semaphore (queue) object handle (control block address). </li>
277 </ul>
278
279 </div>
280 </div>
281 <a class="anchor" id="gab5329701b85d1d3a0142f2a1817936f6"></a>
282 <div class="memitem">
283 <div class="memproto">
284       <table class="memname">
285         <tr>
286           <td class="memname">void EvrFreeRTOSQueue_CreateCountingSemaphoreFailed </td>
287           <td>(</td>
288           <td class="paramtype">void&#160;</td>
289           <td class="paramname"></td><td>)</td>
290           <td></td>
291         </tr>
292       </table>
293 </div><div class="memdoc">
294 <p>The event <b>CreateCountingSemaphoreFailed</b> is generated when semaphore object create fails due to insufficient heap memory. </p>
295
296 </div>
297 </div>
298 <a class="anchor" id="gae20f59e74e83d37657e9950539337c0c"></a>
299 <div class="memitem">
300 <div class="memproto">
301       <table class="memname">
302         <tr>
303           <td class="memname">void EvrFreeRTOSQueue_CreateMutex </td>
304           <td>(</td>
305           <td class="paramtype">Queue_t&#160;</td>
306           <td class="paramname"><em>pxNewQueue</em></td><td>)</td>
307           <td></td>
308         </tr>
309       </table>
310 </div><div class="memdoc">
311 <dl class="params"><dt>Parameters</dt><dd>
312   <table class="params">
313     <tr><td class="paramdir">[in]</td><td class="paramname">pxNewQueue</td><td>pointer to queue object handle.</td></tr>
314   </table>
315   </dd>
316 </dl>
317 <p>The event <b>CreateMutex</b> is generated when mutex object is successfully created.</p>
318 <p><b>Value</b> in the Event Recorder shows:</p>
319 <ul>
320 <li><b>pxNewQueue</b> : pointer to mutex (queue) object handle (control block address). </li>
321 </ul>
322
323 </div>
324 </div>
325 <a class="anchor" id="ga3ec552a8f0ca9630804405e6c46f75ab"></a>
326 <div class="memitem">
327 <div class="memproto">
328       <table class="memname">
329         <tr>
330           <td class="memname">void EvrFreeRTOSQueue_CreateMutexFailed </td>
331           <td>(</td>
332           <td class="paramtype">void&#160;</td>
333           <td class="paramname"></td><td>)</td>
334           <td></td>
335         </tr>
336       </table>
337 </div><div class="memdoc">
338 <p>The event <b>CreateMutexFailed</b> is generated when mutex object create fails due to insufficient heap memory. </p>
339
340 </div>
341 </div>
342 <a class="anchor" id="ga685d7646105897c13f096fb26257e18b"></a>
343 <div class="memitem">
344 <div class="memproto">
345       <table class="memname">
346         <tr>
347           <td class="memname">void EvrFreeRTOSQueue_GiveMutexRecursive </td>
348           <td>(</td>
349           <td class="paramtype">Queue_t&#160;</td>
350           <td class="paramname"><em>pxMutex</em></td><td>)</td>
351           <td></td>
352         </tr>
353       </table>
354 </div><div class="memdoc">
355 <dl class="params"><dt>Parameters</dt><dd>
356   <table class="params">
357     <tr><td class="paramdir">[in]</td><td class="paramname">pxMutex</td><td>pointer to mutex object handle.</td></tr>
358   </table>
359   </dd>
360 </dl>
361 <p>The event <b>GiveMutexRecursive</b> is generated when mutex give operation is successfully executed.</p>
362 <p><b>Value</b> in the Event Recorder shows:</p>
363 <ul>
364 <li><b>pxMutex</b> : pointer to mutex (queue) object handle (control block address). </li>
365 </ul>
366
367 </div>
368 </div>
369 <a class="anchor" id="ga133bfa4aa98cec148bbcfe7e966fd3c8"></a>
370 <div class="memitem">
371 <div class="memproto">
372       <table class="memname">
373         <tr>
374           <td class="memname">void EvrFreeRTOSQueue_GiveMutexRecursiveFailed </td>
375           <td>(</td>
376           <td class="paramtype">Queue_t&#160;</td>
377           <td class="paramname"><em>pxMutex</em></td><td>)</td>
378           <td></td>
379         </tr>
380       </table>
381 </div><div class="memdoc">
382 <dl class="params"><dt>Parameters</dt><dd>
383   <table class="params">
384     <tr><td class="paramdir">[in]</td><td class="paramname">pxMutex</td><td>pointer to mutex object handle.</td></tr>
385   </table>
386   </dd>
387 </dl>
388 <p>The event <b>GiveMutexRecursiveFailed</b> is generated when recursive mutex give operation was not successful.</p>
389 <p><b>Value</b> in the Event Recorder shows:</p>
390 <ul>
391 <li><b>pxMutex</b> : pointer to mutex (queue) object handle (control block address). </li>
392 </ul>
393
394 </div>
395 </div>
396 <a class="anchor" id="gaf65ca7e52be7c04919cd73c9e0927c44"></a>
397 <div class="memitem">
398 <div class="memproto">
399       <table class="memname">
400         <tr>
401           <td class="memname">void EvrFreeRTOSQueue_QueueCreate </td>
402           <td>(</td>
403           <td class="paramtype">Queue_t&#160;</td>
404           <td class="paramname"><em>pxQueue</em></td><td>)</td>
405           <td></td>
406         </tr>
407       </table>
408 </div><div class="memdoc">
409 <dl class="params"><dt>Parameters</dt><dd>
410   <table class="params">
411     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to mutex object handle.</td></tr>
412   </table>
413   </dd>
414 </dl>
415 <p>The event <b>QueueCreate</b> is generated when queue object is successfully created.</p>
416 <p><b>Value</b> in the Event Recorder shows:</p>
417 <ul>
418 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
419 </ul>
420
421 </div>
422 </div>
423 <a class="anchor" id="ga9835b0034b54ff700734ce8d96a8884e"></a>
424 <div class="memitem">
425 <div class="memproto">
426       <table class="memname">
427         <tr>
428           <td class="memname">void EvrFreeRTOSQueue_QueueCreateFailed </td>
429           <td>(</td>
430           <td class="paramtype">uint32_t&#160;</td>
431           <td class="paramname"><em>ucQueueType</em></td><td>)</td>
432           <td></td>
433         </tr>
434       </table>
435 </div><div class="memdoc">
436 <dl class="params"><dt>Parameters</dt><dd>
437   <table class="params">
438     <tr><td class="paramdir">[in]</td><td class="paramname">ucQueueType</td><td>queue type</td></tr>
439   </table>
440   </dd>
441 </dl>
442 <p>The event <b>QueueCreateFailed</b> is generated when queue object create fails due to insufficient heap memory.</p>
443 <p><b>Value</b> in the Event Recorder shows:</p>
444 <ul>
445 <li><b>ucQueueType</b> : x </li>
446 </ul>
447
448 </div>
449 </div>
450 <a class="anchor" id="gade932b1d4bfc68a5c023e94e0506ca6a"></a>
451 <div class="memitem">
452 <div class="memproto">
453       <table class="memname">
454         <tr>
455           <td class="memname">void EvrFreeRTOSQueue_QueueDelete </td>
456           <td>(</td>
457           <td class="paramtype">Queue_t&#160;</td>
458           <td class="paramname"><em>pxQueue</em></td><td>)</td>
459           <td></td>
460         </tr>
461       </table>
462 </div><div class="memdoc">
463 <dl class="params"><dt>Parameters</dt><dd>
464   <table class="params">
465     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
466   </table>
467   </dd>
468 </dl>
469 <p>The event <b>QueueDelete</b> is generated when the function vQueueDelete is called.</p>
470 <p><b>Value</b> in the Event Recorder shows:</p>
471 <ul>
472 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
473 </ul>
474
475 </div>
476 </div>
477 <a class="anchor" id="gaa3bc9dbb9e5c5deab9fed12cd2cb627f"></a>
478 <div class="memitem">
479 <div class="memproto">
480       <table class="memname">
481         <tr>
482           <td class="memname">void EvrFreeRTOSQueue_QueuePeek </td>
483           <td>(</td>
484           <td class="paramtype">Queue_t&#160;</td>
485           <td class="paramname"><em>pxQueue</em></td><td>)</td>
486           <td></td>
487         </tr>
488       </table>
489 </div><div class="memdoc">
490 <dl class="params"><dt>Parameters</dt><dd>
491   <table class="params">
492     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
493   </table>
494   </dd>
495 </dl>
496 <p>The event <b>QueuePeek</b> is generated when the queue peek operation was successful.</p>
497 <p><b>Value</b> in the Event Recorder shows:</p>
498 <ul>
499 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
500 </ul>
501
502 </div>
503 </div>
504 <a class="anchor" id="ga3a76836bcf6f9a82a8b0c7d7166185af"></a>
505 <div class="memitem">
506 <div class="memproto">
507       <table class="memname">
508         <tr>
509           <td class="memname">void EvrFreeRTOSQueue_QueuePeekFromIsr </td>
510           <td>(</td>
511           <td class="paramtype">Queue_t&#160;</td>
512           <td class="paramname"><em>pxQueue</em></td><td>)</td>
513           <td></td>
514         </tr>
515       </table>
516 </div><div class="memdoc">
517 <dl class="params"><dt>Parameters</dt><dd>
518   <table class="params">
519     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
520   </table>
521   </dd>
522 </dl>
523 <p>The event <b>QueuePeekFromIsr</b> is generated when the queue peek from ISR operation was successful.</p>
524 <p><b>Value</b> in the Event Recorder shows:</p>
525 <ul>
526 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
527 </ul>
528
529 </div>
530 </div>
531 <a class="anchor" id="ga6a0c0cfd4c954e66867adcdee0d595d8"></a>
532 <div class="memitem">
533 <div class="memproto">
534       <table class="memname">
535         <tr>
536           <td class="memname">void EvrFreeRTOSQueue_QueuePeekFromIsrFailed </td>
537           <td>(</td>
538           <td class="paramtype">Queue_t&#160;</td>
539           <td class="paramname"><em>pxQueue</em></td><td>)</td>
540           <td></td>
541         </tr>
542       </table>
543 </div><div class="memdoc">
544 <dl class="params"><dt>Parameters</dt><dd>
545   <table class="params">
546     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
547   </table>
548   </dd>
549 </dl>
550 <p>The event <b>QueuePeekFromIsrFailed</b> is generated when queue peek operation is executed from an ISR and the queue is empty.</p>
551 <p><b>Value</b> in the Event Recorder shows:</p>
552 <ul>
553 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
554 </ul>
555
556 </div>
557 </div>
558 <a class="anchor" id="gaa808374145d4e6c9b15573a6d4f10b44"></a>
559 <div class="memitem">
560 <div class="memproto">
561       <table class="memname">
562         <tr>
563           <td class="memname">void EvrFreeRTOSQueue_QueueReceive </td>
564           <td>(</td>
565           <td class="paramtype">Queue_t&#160;</td>
566           <td class="paramname"><em>pxQueue</em></td><td>)</td>
567           <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">pxQueue</td><td>pointer to queue object handle.</td></tr>
574   </table>
575   </dd>
576 </dl>
577 <p>The event <b>QueueReceive</b> is generated when the queue receive operation was successful.</p>
578 <p><b>Value</b> in the Event Recorder shows:</p>
579 <ul>
580 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
581 </ul>
582
583 </div>
584 </div>
585 <a class="anchor" id="ga18237d199bd932452e23b75b317b45f0"></a>
586 <div class="memitem">
587 <div class="memproto">
588       <table class="memname">
589         <tr>
590           <td class="memname">void EvrFreeRTOSQueue_QueueReceiveFailed </td>
591           <td>(</td>
592           <td class="paramtype">Queue_t&#160;</td>
593           <td class="paramname"><em>pxQueue</em></td><td>)</td>
594           <td></td>
595         </tr>
596       </table>
597 </div><div class="memdoc">
598 <dl class="params"><dt>Parameters</dt><dd>
599   <table class="params">
600     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
601   </table>
602   </dd>
603 </dl>
604 <p>The event <b>QueueReceiveFailed</b> is generated when the queue receive operation failed because the queue was empty.</p>
605 <p><b>Value</b> in the Event Recorder shows:</p>
606 <ul>
607 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
608 </ul>
609
610 </div>
611 </div>
612 <a class="anchor" id="ga8e31694e053094dd88fecf7fc0fa764e"></a>
613 <div class="memitem">
614 <div class="memproto">
615       <table class="memname">
616         <tr>
617           <td class="memname">void EvrFreeRTOSQueue_QueueReceiveFromIsr </td>
618           <td>(</td>
619           <td class="paramtype">Queue_t&#160;</td>
620           <td class="paramname"><em>pxQueue</em></td><td>)</td>
621           <td></td>
622         </tr>
623       </table>
624 </div><div class="memdoc">
625 <dl class="params"><dt>Parameters</dt><dd>
626   <table class="params">
627     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
628   </table>
629   </dd>
630 </dl>
631 <p>The event <b>QueueReceiveFromIsr</b> is generated when the queue receive from ISR operation was successful.</p>
632 <p><b>Value</b> in the Event Recorder shows:</p>
633 <ul>
634 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
635 </ul>
636
637 </div>
638 </div>
639 <a class="anchor" id="ga2fbc27227935a83ab5b90e78f5dd617e"></a>
640 <div class="memitem">
641 <div class="memproto">
642       <table class="memname">
643         <tr>
644           <td class="memname">void EvrFreeRTOSQueue_QueueReceiveFromIsrFailed </td>
645           <td>(</td>
646           <td class="paramtype">Queue_t&#160;</td>
647           <td class="paramname"><em>pxQueue</em></td><td>)</td>
648           <td></td>
649         </tr>
650       </table>
651 </div><div class="memdoc">
652 <dl class="params"><dt>Parameters</dt><dd>
653   <table class="params">
654     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
655   </table>
656   </dd>
657 </dl>
658 <p>The event <b>QueueReceiveFromIsrFailed</b> is generated when the queue receive operation fails due to the queue already being empty.</p>
659 <p><b>Value</b> in the Event Recorder shows:</p>
660 <ul>
661 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
662 </ul>
663
664 </div>
665 </div>
666 <a class="anchor" id="ga9a8c0960e13c7ba48e9416e2b17ce0fc"></a>
667 <div class="memitem">
668 <div class="memproto">
669       <table class="memname">
670         <tr>
671           <td class="memname">void EvrFreeRTOSQueue_QueueRegistryAdd </td>
672           <td>(</td>
673           <td class="paramtype">Queue_t&#160;</td>
674           <td class="paramname"><em>pxQueue</em>, </td>
675         </tr>
676         <tr>
677           <td class="paramkey"></td>
678           <td></td>
679           <td class="paramtype">const char *&#160;</td>
680           <td class="paramname"><em>pcQueueName</em>&#160;</td>
681         </tr>
682         <tr>
683           <td></td>
684           <td>)</td>
685           <td></td><td></td>
686         </tr>
687       </table>
688 </div><div class="memdoc">
689 <dl class="params"><dt>Parameters</dt><dd>
690   <table class="params">
691     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle. </td></tr>
692     <tr><td class="paramdir">[in]</td><td class="paramname">pcQueueName</td><td>pointer to queue object name.</td></tr>
693   </table>
694   </dd>
695 </dl>
696 <p>The event <b>QueueRegistryAdd</b> is generated when a human readable name is registered to the specified queue.</p>
697 <p><b>Value</b> in the Event Recorder shows:</p>
698 <ul>
699 <li><b>pxQueue</b> : pointer to queue object handle (control block address).</li>
700 <li><b>pcQueueName</b> : pointer to the ASCII string. </li>
701 </ul>
702
703 </div>
704 </div>
705 <a class="anchor" id="ga107ec0fa12e1cc88f50be0cd0531ceb0"></a>
706 <div class="memitem">
707 <div class="memproto">
708       <table class="memname">
709         <tr>
710           <td class="memname">void EvrFreeRTOSQueue_QueueSend </td>
711           <td>(</td>
712           <td class="paramtype">Queue_t&#160;</td>
713           <td class="paramname"><em>pxQueue</em></td><td>)</td>
714           <td></td>
715         </tr>
716       </table>
717 </div><div class="memdoc">
718 <dl class="params"><dt>Parameters</dt><dd>
719   <table class="params">
720     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
721   </table>
722   </dd>
723 </dl>
724 <p>The event <b>QueueSend</b> is generated when the queue send operation was successful.</p>
725 <p><b>Value</b> in the Event Recorder shows:</p>
726 <ul>
727 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
728 </ul>
729
730 </div>
731 </div>
732 <a class="anchor" id="ga9b5109c8b791ec28631d98e28649ca7d"></a>
733 <div class="memitem">
734 <div class="memproto">
735       <table class="memname">
736         <tr>
737           <td class="memname">void EvrFreeRTOSQueue_QueueSendFailed </td>
738           <td>(</td>
739           <td class="paramtype">Queue_t&#160;</td>
740           <td class="paramname"><em>pxQueue</em></td><td>)</td>
741           <td></td>
742         </tr>
743       </table>
744 </div><div class="memdoc">
745 <dl class="params"><dt>Parameters</dt><dd>
746   <table class="params">
747     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
748   </table>
749   </dd>
750 </dl>
751 <p>The event <b>QueueSendFailed</b> is generated when the queue send operation fails due to the queue being full.</p>
752 <p><b>Value</b> in the Event Recorder shows:</p>
753 <ul>
754 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
755 </ul>
756
757 </div>
758 </div>
759 <a class="anchor" id="ga0308f241666bc80e9ff3357b701aed27"></a>
760 <div class="memitem">
761 <div class="memproto">
762       <table class="memname">
763         <tr>
764           <td class="memname">void EvrFreeRTOSQueue_QueueSendFromIsr </td>
765           <td>(</td>
766           <td class="paramtype">Queue_t&#160;</td>
767           <td class="paramname"><em>pxQueue</em></td><td>)</td>
768           <td></td>
769         </tr>
770       </table>
771 </div><div class="memdoc">
772 <dl class="params"><dt>Parameters</dt><dd>
773   <table class="params">
774     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
775   </table>
776   </dd>
777 </dl>
778 <p>The event <b>QueueSendFromIsr</b> is generated when the queue send from ISR operation was successful.</p>
779 <p><b>Value</b> in the Event Recorder shows:</p>
780 <ul>
781 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
782 </ul>
783
784 </div>
785 </div>
786 <a class="anchor" id="gabcbc7ca489384b8fc4cf6d88a0819960"></a>
787 <div class="memitem">
788 <div class="memproto">
789       <table class="memname">
790         <tr>
791           <td class="memname">void EvrFreeRTOSQueue_QueueSendFromIsrFailed </td>
792           <td>(</td>
793           <td class="paramtype">Queue_t&#160;</td>
794           <td class="paramname"><em>pxQueue</em></td><td>)</td>
795           <td></td>
796         </tr>
797       </table>
798 </div><div class="memdoc">
799 <dl class="params"><dt>Parameters</dt><dd>
800   <table class="params">
801     <tr><td class="paramdir">[in]</td><td class="paramname">pxQueue</td><td>pointer to queue object handle.</td></tr>
802   </table>
803   </dd>
804 </dl>
805 <p>The event <b>QueueSendFromIsrFailed</b> is generated when the queue send operation fails due to the queue already being full.</p>
806 <p><b>Value</b> in the Event Recorder shows:</p>
807 <ul>
808 <li><b>pxQueue</b> : pointer to queue object handle (control block address). </li>
809 </ul>
810
811 </div>
812 </div>
813 <a class="anchor" id="gae523dab25c47359f13267aa5f1496a6e"></a>
814 <div class="memitem">
815 <div class="memproto">
816       <table class="memname">
817         <tr>
818           <td class="memname">void EvrFreeRTOSQueue_TakeMutexRecursive </td>
819           <td>(</td>
820           <td class="paramtype">Queue_t&#160;</td>
821           <td class="paramname"><em>pxMutex</em></td><td>)</td>
822           <td></td>
823         </tr>
824       </table>
825 </div><div class="memdoc">
826 <dl class="params"><dt>Parameters</dt><dd>
827   <table class="params">
828     <tr><td class="paramdir">[in]</td><td class="paramname">pxMutex</td><td>pointer to mutex object handle.</td></tr>
829   </table>
830   </dd>
831 </dl>
832 <p>The event <b>TakeMutexRecursive</b> is generated when recursive mutex take operation is successfully executed.</p>
833 <p><b>Value</b> in the Event Recorder shows:</p>
834 <ul>
835 <li><b>pxMutex</b> : pointer to mutex (queue) object handle (control block address). </li>
836 </ul>
837
838 </div>
839 </div>
840 <a class="anchor" id="gaf0e44408b746e8fa9c2ae43494717eb0"></a>
841 <div class="memitem">
842 <div class="memproto">
843       <table class="memname">
844         <tr>
845           <td class="memname">void EvrFreeRTOSQueue_TakeMutexRecursiveFailed </td>
846           <td>(</td>
847           <td class="paramtype">Queue_t&#160;</td>
848           <td class="paramname"><em>pxMutex</em></td><td>)</td>
849           <td></td>
850         </tr>
851       </table>
852 </div><div class="memdoc">
853 <dl class="params"><dt>Parameters</dt><dd>
854   <table class="params">
855     <tr><td class="paramdir">[in]</td><td class="paramname">pxMutex</td><td>pointer to mutex object handle.</td></tr>
856   </table>
857   </dd>
858 </dl>
859 <p>The event <b>TakeMutexRecursiveFailed</b> is generated when recursive mutex take operation is not successful.</p>
860 <p><b>Value</b> in the Event Recorder shows:</p>
861 <ul>
862 <li><b>pxMutex</b> : pointer to mutex (queue) object handle (control block address). </li>
863 </ul>
864
865 </div>
866 </div>
867 </div><!-- contents -->
868 </div><!-- doc-content -->
869 <!-- start footer part -->
870 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
871   <ul>
872     <li class="footer">Generated on Fri Aug 11 2017 17:16:34 for CMSIS-FreeRTOS by ARM Ltd. All rights reserved.
873         <!--
874     <a href="http://www.doxygen.org/index.html">
875     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 
876         -->
877         </li>
878   </ul>
879 </div>
880 </body>
881 </html>