group__rtx__evr__message__queue.html 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126
  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-RTOS2: 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-RTOS2
  35. &#160;<span id="projectnumber">Version 2.1.3</span>
  36. </div>
  37. <div id="projectbrief">Real-Time Operating System: API and RTX Reference 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__rtx__evr__message__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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle">
  111. <div class="title">Message Queue Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Events generated by message queue functions.
  115. <a href="#details">More...</a></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  118. Functions</h2></td></tr>
  119. <tr class="memitem:ga8ded1d43703e0885a81e65251c6df405"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga8ded1d43703e0885a81e65251c6df405">EvrRtxMessageQueueError</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, int32_t status)</td></tr>
  120. <tr class="memdesc:ga8ded1d43703e0885a81e65251c6df405"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue error (Error) <a href="#ga8ded1d43703e0885a81e65251c6df405">More...</a><br/></td></tr>
  121. <tr class="separator:ga8ded1d43703e0885a81e65251c6df405"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:gaa7b18f18f3f53d6afb39ac1abe257000"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gaa7b18f18f3f53d6afb39ac1abe257000">EvrRtxMessageQueueNew</a> (uint32_t msg_count, uint32_t msg_size, const <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">osMessageQueueAttr_t</a> *attr)</td></tr>
  123. <tr class="memdesc:gaa7b18f18f3f53d6afb39ac1abe257000"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue create and initialization (API) <a href="#gaa7b18f18f3f53d6afb39ac1abe257000">More...</a><br/></td></tr>
  124. <tr class="separator:gaa7b18f18f3f53d6afb39ac1abe257000"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ga36d6982377c1f54a227ba6fbb9458b79"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga36d6982377c1f54a227ba6fbb9458b79">EvrRtxMessageQueueCreated</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const char *name)</td></tr>
  126. <tr class="memdesc:ga36d6982377c1f54a227ba6fbb9458b79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful message queue create (Op) <a href="#ga36d6982377c1f54a227ba6fbb9458b79">More...</a><br/></td></tr>
  127. <tr class="separator:ga36d6982377c1f54a227ba6fbb9458b79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:gad0ef8ee59d2ec189351c5884f5f8e945"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gad0ef8ee59d2ec189351c5884f5f8e945">EvrRtxMessageQueueGetName</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const char *name)</td></tr>
  129. <tr class="memdesc:gad0ef8ee59d2ec189351c5884f5f8e945"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue name retrieve(API) <a href="#gad0ef8ee59d2ec189351c5884f5f8e945">More...</a><br/></td></tr>
  130. <tr class="separator:gad0ef8ee59d2ec189351c5884f5f8e945"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga401536a603e5a805cc6089b4de11d3d3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga401536a603e5a805cc6089b4de11d3d3">EvrRtxMessageQueuePut</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t timeout)</td></tr>
  132. <tr class="memdesc:ga401536a603e5a805cc6089b4de11d3d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message put (API) <a href="#ga401536a603e5a805cc6089b4de11d3d3">More...</a><br/></td></tr>
  133. <tr class="separator:ga401536a603e5a805cc6089b4de11d3d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ga4b1b6191c6ca87dff4714e25b5845828"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga4b1b6191c6ca87dff4714e25b5845828">EvrRtxMessageQueuePutPending</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr, uint32_t timeout)</td></tr>
  135. <tr class="memdesc:ga4b1b6191c6ca87dff4714e25b5845828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pending message put (Op) <a href="#ga4b1b6191c6ca87dff4714e25b5845828">More...</a><br/></td></tr>
  136. <tr class="separator:ga4b1b6191c6ca87dff4714e25b5845828"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ga7394ca2d88255470f7ba0bb2bff12e99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga7394ca2d88255470f7ba0bb2bff12e99">EvrRtxMessageQueuePutTimeout</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
  138. <tr class="memdesc:ga7394ca2d88255470f7ba0bb2bff12e99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message put timeout (Op) <a href="#ga7394ca2d88255470f7ba0bb2bff12e99">More...</a><br/></td></tr>
  139. <tr class="separator:ga7394ca2d88255470f7ba0bb2bff12e99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ga8440223b9d48145df5505489e7c6f7d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga8440223b9d48145df5505489e7c6f7d9">EvrRtxMessageQueueInsertPending</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr)</td></tr>
  141. <tr class="memdesc:ga8440223b9d48145df5505489e7c6f7d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pending message insert (Op) <a href="#ga8440223b9d48145df5505489e7c6f7d9">More...</a><br/></td></tr>
  142. <tr class="separator:ga8440223b9d48145df5505489e7c6f7d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:gaa30c5b375d4050ad7d99ba094821bf52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gaa30c5b375d4050ad7d99ba094821bf52">EvrRtxMessageQueueInserted</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr)</td></tr>
  144. <tr class="memdesc:gaa30c5b375d4050ad7d99ba094821bf52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful message insert (Op) <a href="#gaa30c5b375d4050ad7d99ba094821bf52">More...</a><br/></td></tr>
  145. <tr class="separator:gaa30c5b375d4050ad7d99ba094821bf52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ga2922125d8ac63fd800dc3b7888fd3f3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga2922125d8ac63fd800dc3b7888fd3f3c">EvrRtxMessageQueueNotInserted</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr)</td></tr>
  147. <tr class="memdesc:ga2922125d8ac63fd800dc3b7888fd3f3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful message insert (Op) <a href="#ga2922125d8ac63fd800dc3b7888fd3f3c">More...</a><br/></td></tr>
  148. <tr class="separator:ga2922125d8ac63fd800dc3b7888fd3f3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ga0826c1d05d3a99afb8682f0ca3f7fd62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga0826c1d05d3a99afb8682f0ca3f7fd62">EvrRtxMessageQueueGet</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t timeout)</td></tr>
  150. <tr class="memdesc:ga0826c1d05d3a99afb8682f0ca3f7fd62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message get (API) <a href="#ga0826c1d05d3a99afb8682f0ca3f7fd62">More...</a><br/></td></tr>
  151. <tr class="separator:ga0826c1d05d3a99afb8682f0ca3f7fd62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ga11e3df32a66d5240b277375cbb5d3c83"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga11e3df32a66d5240b277375cbb5d3c83">EvrRtxMessageQueueGetPending</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr, uint32_t timeout)</td></tr>
  153. <tr class="memdesc:ga11e3df32a66d5240b277375cbb5d3c83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on pending message get (Op) <a href="#ga11e3df32a66d5240b277375cbb5d3c83">More...</a><br/></td></tr>
  154. <tr class="separator:ga11e3df32a66d5240b277375cbb5d3c83"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ga5e699de7401c46fd0e8bc19e398dc5a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga5e699de7401c46fd0e8bc19e398dc5a8">EvrRtxMessageQueueGetTimeout</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
  156. <tr class="memdesc:ga5e699de7401c46fd0e8bc19e398dc5a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message get timeout (Op) <a href="#ga5e699de7401c46fd0e8bc19e398dc5a8">More...</a><br/></td></tr>
  157. <tr class="separator:ga5e699de7401c46fd0e8bc19e398dc5a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:gab340b38df5d8bf2a1182fd18f2d3a6c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gab340b38df5d8bf2a1182fd18f2d3a6c4">EvrRtxMessageQueueRetrieved</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr)</td></tr>
  159. <tr class="memdesc:gab340b38df5d8bf2a1182fd18f2d3a6c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful message get (Op) <a href="#gab340b38df5d8bf2a1182fd18f2d3a6c4">More...</a><br/></td></tr>
  160. <tr class="separator:gab340b38df5d8bf2a1182fd18f2d3a6c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ga22bfb7d1c2f6e3e9fea9d3267b2d6988"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga22bfb7d1c2f6e3e9fea9d3267b2d6988">EvrRtxMessageQueueNotRetrieved</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr)</td></tr>
  162. <tr class="memdesc:ga22bfb7d1c2f6e3e9fea9d3267b2d6988"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on unsuccessful message get (Op) <a href="#ga22bfb7d1c2f6e3e9fea9d3267b2d6988">More...</a><br/></td></tr>
  163. <tr class="separator:ga22bfb7d1c2f6e3e9fea9d3267b2d6988"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:gad423a0be13d65e98d9ae08de9c399615"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gad423a0be13d65e98d9ae08de9c399615">EvrRtxMessageQueueGetCapacity</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t capacity)</td></tr>
  165. <tr class="memdesc:gad423a0be13d65e98d9ae08de9c399615"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue capacity retrieve (API) <a href="#gad423a0be13d65e98d9ae08de9c399615">More...</a><br/></td></tr>
  166. <tr class="separator:gad423a0be13d65e98d9ae08de9c399615"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ga3d6348bed3937de29765ed4d7d07fac8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga3d6348bed3937de29765ed4d7d07fac8">EvrRtxMessageQueueGetMsgSize</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t msg_size)</td></tr>
  168. <tr class="memdesc:ga3d6348bed3937de29765ed4d7d07fac8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue message size retrieve (API) <a href="#ga3d6348bed3937de29765ed4d7d07fac8">More...</a><br/></td></tr>
  169. <tr class="separator:ga3d6348bed3937de29765ed4d7d07fac8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ga145f0c464382dc71ff3b1c624b8bd570"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga145f0c464382dc71ff3b1c624b8bd570">EvrRtxMessageQueueGetCount</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t count)</td></tr>
  171. <tr class="memdesc:ga145f0c464382dc71ff3b1c624b8bd570"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue message count retrieve (API) <a href="#ga145f0c464382dc71ff3b1c624b8bd570">More...</a><br/></td></tr>
  172. <tr class="separator:ga145f0c464382dc71ff3b1c624b8bd570"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:ga6cfce7336f58505a2379a8a71f477d2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga6cfce7336f58505a2379a8a71f477d2f">EvrRtxMessageQueueGetSpace</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t space)</td></tr>
  174. <tr class="memdesc:ga6cfce7336f58505a2379a8a71f477d2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue message slots retrieve (API) <a href="#ga6cfce7336f58505a2379a8a71f477d2f">More...</a><br/></td></tr>
  175. <tr class="separator:ga6cfce7336f58505a2379a8a71f477d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:ga91b8c8630c7d89b6b6dbb74d4fc81ba4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga91b8c8630c7d89b6b6dbb74d4fc81ba4">EvrRtxMessageQueueReset</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
  177. <tr class="memdesc:ga91b8c8630c7d89b6b6dbb74d4fc81ba4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue reset (API) <a href="#ga91b8c8630c7d89b6b6dbb74d4fc81ba4">More...</a><br/></td></tr>
  178. <tr class="separator:ga91b8c8630c7d89b6b6dbb74d4fc81ba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:ga3947d4a7ac86ee7a50052c9eb4cd5432"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga3947d4a7ac86ee7a50052c9eb4cd5432">EvrRtxMessageQueueResetDone</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
  180. <tr class="memdesc:ga3947d4a7ac86ee7a50052c9eb4cd5432"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful message queue reset (Op) <a href="#ga3947d4a7ac86ee7a50052c9eb4cd5432">More...</a><br/></td></tr>
  181. <tr class="separator:ga3947d4a7ac86ee7a50052c9eb4cd5432"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:gad11606ef82f5b82f291bf64adfc805e4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gad11606ef82f5b82f291bf64adfc805e4">EvrRtxMessageQueueDelete</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
  183. <tr class="memdesc:gad11606ef82f5b82f291bf64adfc805e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on message queue delete (API) <a href="#gad11606ef82f5b82f291bf64adfc805e4">More...</a><br/></td></tr>
  184. <tr class="separator:gad11606ef82f5b82f291bf64adfc805e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:ga3bbf02128c31e5cc7ef4c78cdbec508c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga3bbf02128c31e5cc7ef4c78cdbec508c">EvrRtxMessageQueueDestroyed</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
  186. <tr class="memdesc:ga3bbf02128c31e5cc7ef4c78cdbec508c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on successful message queue delete (Op) <a href="#ga3bbf02128c31e5cc7ef4c78cdbec508c">More...</a><br/></td></tr>
  187. <tr class="separator:ga3bbf02128c31e5cc7ef4c78cdbec508c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. </table>
  189. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  190. <h2 class="groupheader">Function Documentation</h2>
  191. <a class="anchor" id="ga8ded1d43703e0885a81e65251c6df405"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">void EvrRtxMessageQueueError </td>
  197. <td>(</td>
  198. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  199. <td class="paramname"><em>mq_id</em>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype">int32_t&#160;</td>
  205. <td class="paramname"><em>status</em>&#160;</td>
  206. </tr>
  207. <tr>
  208. <td></td>
  209. <td>)</td>
  210. <td></td><td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <dl class="params"><dt>Parameters</dt><dd>
  215. <table class="params">
  216. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> or NULL when ID is unknown. </td></tr>
  217. <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  218. </table>
  219. </dd>
  220. </dl>
  221. <p>The event <b>MessageQueueError</b> is generated when <a class="el" href="group__CMSIS__RTOS__Message.html">Message Queue</a> routines complete their execution due to an error.</p>
  222. <p>The status parameter indicates the execution status and can be one of the <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t codes</a> or one of the extended execution status codes which are summarized in the table below.</p>
  223. <table class="doxtable">
  224. <tr>
  225. <th align="left">Extended Status Code </th><th align="left">Description </th></tr>
  226. <tr>
  227. <td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr>
  228. <tr>
  229. <td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr>
  230. <tr>
  231. <td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr>
  232. <tr>
  233. <td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr>
  234. <tr>
  235. <td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr>
  236. <tr>
  237. <td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr>
  238. <tr>
  239. <td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr>
  240. <tr>
  241. <td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr>
  242. <tr>
  243. <td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr>
  244. <tr>
  245. <td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr>
  246. <tr>
  247. <td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr>
  248. <tr>
  249. <td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr>
  250. <tr>
  251. <td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr>
  252. <tr>
  253. <td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr>
  254. <tr>
  255. <td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr>
  256. <tr>
  257. <td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr>
  258. </table>
  259. <p><b>Value</b> in the Event Recorder shows:</p>
  260. <ul>
  261. <li><b>mq_id</b> : message queue ID.</li>
  262. <li><b>status</b> : execution status code. </li>
  263. </ul>
  264. </div>
  265. </div>
  266. <a class="anchor" id="gaa7b18f18f3f53d6afb39ac1abe257000"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">void EvrRtxMessageQueueNew </td>
  272. <td>(</td>
  273. <td class="paramtype">uint32_t&#160;</td>
  274. <td class="paramname"><em>msg_count</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype">uint32_t&#160;</td>
  280. <td class="paramname"><em>msg_size</em>, </td>
  281. </tr>
  282. <tr>
  283. <td class="paramkey"></td>
  284. <td></td>
  285. <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">osMessageQueueAttr_t</a> *&#160;</td>
  286. <td class="paramname"><em>attr</em>&#160;</td>
  287. </tr>
  288. <tr>
  289. <td></td>
  290. <td>)</td>
  291. <td></td><td></td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <dl class="params"><dt>Parameters</dt><dd>
  296. <table class="params">
  297. <tr><td class="paramdir">[in]</td><td class="paramname">msg_count</td><td>maximum number of messages in queue. </td></tr>
  298. <tr><td class="paramdir">[in]</td><td class="paramname">msg_size</td><td>maximum message size in bytes. </td></tr>
  299. <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>message queue attributes; NULL: default values.</td></tr>
  300. </table>
  301. </dd>
  302. </dl>
  303. <p>The event <b>MessageQueueNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> is called.</p>
  304. <p><b>Value</b> in the Event Recorder shows:</p>
  305. <ul>
  306. <li><b>msg_count</b> : maximum number of messages in queue.</li>
  307. <li><b>msg_size</b> : maximum message size in bytes.</li>
  308. <li><b>attr</b> : memory address of Message Queue attributes or 0 when they are not specified.</li>
  309. </ul>
  310. <p>In case when <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">message queue attributes</a> are provided in the API call they are also detailed in the Event Recorder. </p>
  311. </div>
  312. </div>
  313. <a class="anchor" id="ga36d6982377c1f54a227ba6fbb9458b79"></a>
  314. <div class="memitem">
  315. <div class="memproto">
  316. <table class="memname">
  317. <tr>
  318. <td class="memname">void EvrRtxMessageQueueCreated </td>
  319. <td>(</td>
  320. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  321. <td class="paramname"><em>mq_id</em>, </td>
  322. </tr>
  323. <tr>
  324. <td class="paramkey"></td>
  325. <td></td>
  326. <td class="paramtype">const char *&#160;</td>
  327. <td class="paramname"><em>name</em>&#160;</td>
  328. </tr>
  329. <tr>
  330. <td></td>
  331. <td>)</td>
  332. <td></td><td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <dl class="params"><dt>Parameters</dt><dd>
  337. <table class="params">
  338. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  339. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to message queue object name.</td></tr>
  340. </table>
  341. </dd>
  342. </dl>
  343. <p>The event <b>MessageQueueCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> successfully creates a message queue object.</p>
  344. <p><b>Value</b> in the Event Recorder shows:</p>
  345. <ul>
  346. <li><b>mq_id</b> : message queue ID. </li>
  347. </ul>
  348. </div>
  349. </div>
  350. <a class="anchor" id="gad0ef8ee59d2ec189351c5884f5f8e945"></a>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">void EvrRtxMessageQueueGetName </td>
  356. <td>(</td>
  357. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  358. <td class="paramname"><em>mq_id</em>, </td>
  359. </tr>
  360. <tr>
  361. <td class="paramkey"></td>
  362. <td></td>
  363. <td class="paramtype">const char *&#160;</td>
  364. <td class="paramname"><em>name</em>&#160;</td>
  365. </tr>
  366. <tr>
  367. <td></td>
  368. <td>)</td>
  369. <td></td><td></td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <dl class="params"><dt>Parameters</dt><dd>
  374. <table class="params">
  375. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  376. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to message queue object name.</td></tr>
  377. </table>
  378. </dd>
  379. </dl>
  380. <p>The event <b>MessageQueueGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gae7cf7bf2b97a5ae481fb60fcce99247a">osMessageQueueGetName</a> is called and its execution result is known.</p>
  381. <p><b>Value</b> in the Event Recorder shows:</p>
  382. <ul>
  383. <li><b>mq_id</b> : message queue ID.</li>
  384. <li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li>
  385. </ul>
  386. </div>
  387. </div>
  388. <a class="anchor" id="ga401536a603e5a805cc6089b4de11d3d3"></a>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <table class="memname">
  392. <tr>
  393. <td class="memname">void EvrRtxMessageQueuePut </td>
  394. <td>(</td>
  395. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  396. <td class="paramname"><em>mq_id</em>, </td>
  397. </tr>
  398. <tr>
  399. <td class="paramkey"></td>
  400. <td></td>
  401. <td class="paramtype">const void *&#160;</td>
  402. <td class="paramname"><em>msg_ptr</em>, </td>
  403. </tr>
  404. <tr>
  405. <td class="paramkey"></td>
  406. <td></td>
  407. <td class="paramtype">uint8_t&#160;</td>
  408. <td class="paramname"><em>msg_prio</em>, </td>
  409. </tr>
  410. <tr>
  411. <td class="paramkey"></td>
  412. <td></td>
  413. <td class="paramtype">uint32_t&#160;</td>
  414. <td class="paramname"><em>timeout</em>&#160;</td>
  415. </tr>
  416. <tr>
  417. <td></td>
  418. <td>)</td>
  419. <td></td><td></td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <dl class="params"><dt>Parameters</dt><dd>
  424. <table class="params">
  425. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  426. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue. </td></tr>
  427. <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr>
  428. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  429. </table>
  430. </dd>
  431. </dl>
  432. <p>The event <b>MessageQueuePut</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> is called.</p>
  433. <p><b>Value</b> in the Event Recorder shows:</p>
  434. <ul>
  435. <li><b>mq_id</b> : message queue ID.</li>
  436. <li><b>msg_ptr</b> : memory address of message buffer.</li>
  437. <li><b>msg_prio</b> : message priority.</li>
  438. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  439. </ul>
  440. </div>
  441. </div>
  442. <a class="anchor" id="ga4b1b6191c6ca87dff4714e25b5845828"></a>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname">void EvrRtxMessageQueuePutPending </td>
  448. <td>(</td>
  449. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  450. <td class="paramname"><em>mq_id</em>, </td>
  451. </tr>
  452. <tr>
  453. <td class="paramkey"></td>
  454. <td></td>
  455. <td class="paramtype">const void *&#160;</td>
  456. <td class="paramname"><em>msg_ptr</em>, </td>
  457. </tr>
  458. <tr>
  459. <td class="paramkey"></td>
  460. <td></td>
  461. <td class="paramtype">uint32_t&#160;</td>
  462. <td class="paramname"><em>timeout</em>&#160;</td>
  463. </tr>
  464. <tr>
  465. <td></td>
  466. <td>)</td>
  467. <td></td><td></td>
  468. </tr>
  469. </table>
  470. </div><div class="memdoc">
  471. <dl class="params"><dt>Parameters</dt><dd>
  472. <table class="params">
  473. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  474. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue. </td></tr>
  475. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  476. </table>
  477. </dd>
  478. </dl>
  479. <p>The event <b>MessageQueuePutPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> starts waiting to put message into the queue.</p>
  480. <p><b>Value</b> in the Event Recorder shows:</p>
  481. <ul>
  482. <li><b>mq_id</b> : message queue ID.</li>
  483. <li><b>msg_ptr</b> : memory address of message buffer.</li>
  484. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  485. </ul>
  486. </div>
  487. </div>
  488. <a class="anchor" id="ga7394ca2d88255470f7ba0bb2bff12e99"></a>
  489. <div class="memitem">
  490. <div class="memproto">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname">void EvrRtxMessageQueuePutTimeout </td>
  494. <td>(</td>
  495. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  496. <td class="paramname"><em>mq_id</em></td><td>)</td>
  497. <td></td>
  498. </tr>
  499. </table>
  500. </div><div class="memdoc">
  501. <dl class="params"><dt>Parameters</dt><dd>
  502. <table class="params">
  503. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr>
  504. </table>
  505. </dd>
  506. </dl>
  507. <p>The event <b>MessageQueuePutTimeout</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> fails to insert a message into the queue until timeout expires.</p>
  508. <p><b>Value</b> in the Event Recorder shows:</p>
  509. <ul>
  510. <li><b>mq_id</b> : message queue ID. </li>
  511. </ul>
  512. </div>
  513. </div>
  514. <a class="anchor" id="ga8440223b9d48145df5505489e7c6f7d9"></a>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">void EvrRtxMessageQueueInsertPending </td>
  520. <td>(</td>
  521. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  522. <td class="paramname"><em>mq_id</em>, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">const void *&#160;</td>
  528. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  529. </tr>
  530. <tr>
  531. <td></td>
  532. <td>)</td>
  533. <td></td><td></td>
  534. </tr>
  535. </table>
  536. </div><div class="memdoc">
  537. <dl class="params"><dt>Parameters</dt><dd>
  538. <table class="params">
  539. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  540. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue.</td></tr>
  541. </table>
  542. </dd>
  543. </dl>
  544. <p>The event <b>MessageQueueInsertPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> is called from ISR and message is registered to be put into the queue.</p>
  545. <p><b>Value</b> in the Event Recorder shows:</p>
  546. <ul>
  547. <li><b>mq_id</b> : message queue ID.</li>
  548. <li><b>msg_ptr</b> : memory address of message buffer. </li>
  549. </ul>
  550. </div>
  551. </div>
  552. <a class="anchor" id="gaa30c5b375d4050ad7d99ba094821bf52"></a>
  553. <div class="memitem">
  554. <div class="memproto">
  555. <table class="memname">
  556. <tr>
  557. <td class="memname">void EvrRtxMessageQueueInserted </td>
  558. <td>(</td>
  559. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  560. <td class="paramname"><em>mq_id</em>, </td>
  561. </tr>
  562. <tr>
  563. <td class="paramkey"></td>
  564. <td></td>
  565. <td class="paramtype">const void *&#160;</td>
  566. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  567. </tr>
  568. <tr>
  569. <td></td>
  570. <td>)</td>
  571. <td></td><td></td>
  572. </tr>
  573. </table>
  574. </div><div class="memdoc">
  575. <dl class="params"><dt>Parameters</dt><dd>
  576. <table class="params">
  577. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  578. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue.</td></tr>
  579. </table>
  580. </dd>
  581. </dl>
  582. <p>The event <b>MessageQueueInserted</b> is generated when a message is successfully inserted into the queue.</p>
  583. <p><b>Value</b> in the Event Recorder shows:</p>
  584. <ul>
  585. <li><b>mq_id</b> : message queue ID.</li>
  586. <li><b>msg_ptr</b> : memory address of message buffer. </li>
  587. </ul>
  588. </div>
  589. </div>
  590. <a class="anchor" id="ga2922125d8ac63fd800dc3b7888fd3f3c"></a>
  591. <div class="memitem">
  592. <div class="memproto">
  593. <table class="memname">
  594. <tr>
  595. <td class="memname">void EvrRtxMessageQueueNotInserted </td>
  596. <td>(</td>
  597. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  598. <td class="paramname"><em>mq_id</em>, </td>
  599. </tr>
  600. <tr>
  601. <td class="paramkey"></td>
  602. <td></td>
  603. <td class="paramtype">const void *&#160;</td>
  604. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  605. </tr>
  606. <tr>
  607. <td></td>
  608. <td>)</td>
  609. <td></td><td></td>
  610. </tr>
  611. </table>
  612. </div><div class="memdoc">
  613. <dl class="params"><dt>Parameters</dt><dd>
  614. <table class="params">
  615. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  616. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue.</td></tr>
  617. </table>
  618. </dd>
  619. </dl>
  620. <p>The event <b>MessageQueueNotInserted</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> fails to insert a message into the queue. Usually this happens when queue is out of memory.</p>
  621. <p><b>Value</b> in the Event Recorder shows:</p>
  622. <ul>
  623. <li><b>mq_id</b> : message queue ID.</li>
  624. <li><b>msg_ptr</b> : memory address of message buffer. </li>
  625. </ul>
  626. </div>
  627. </div>
  628. <a class="anchor" id="ga0826c1d05d3a99afb8682f0ca3f7fd62"></a>
  629. <div class="memitem">
  630. <div class="memproto">
  631. <table class="memname">
  632. <tr>
  633. <td class="memname">void EvrRtxMessageQueueGet </td>
  634. <td>(</td>
  635. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  636. <td class="paramname"><em>mq_id</em>, </td>
  637. </tr>
  638. <tr>
  639. <td class="paramkey"></td>
  640. <td></td>
  641. <td class="paramtype">void *&#160;</td>
  642. <td class="paramname"><em>msg_ptr</em>, </td>
  643. </tr>
  644. <tr>
  645. <td class="paramkey"></td>
  646. <td></td>
  647. <td class="paramtype">uint8_t *&#160;</td>
  648. <td class="paramname"><em>msg_prio</em>, </td>
  649. </tr>
  650. <tr>
  651. <td class="paramkey"></td>
  652. <td></td>
  653. <td class="paramtype">uint32_t&#160;</td>
  654. <td class="paramname"><em>timeout</em>&#160;</td>
  655. </tr>
  656. <tr>
  657. <td></td>
  658. <td>)</td>
  659. <td></td><td></td>
  660. </tr>
  661. </table>
  662. </div><div class="memdoc">
  663. <dl class="params"><dt>Parameters</dt><dd>
  664. <table class="params">
  665. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  666. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue. </td></tr>
  667. <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr>
  668. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  669. </table>
  670. </dd>
  671. </dl>
  672. <p>The event <b>MessageQueueGet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> is called.</p>
  673. <p><b>Value</b> in the Event Recorder shows:</p>
  674. <ul>
  675. <li><b>mq_id</b> : message queue ID.</li>
  676. <li><b>msg_ptr</b> : memory address of buffer for message.</li>
  677. <li><b>msg_prio</b> : memory address of buffer for message priority.</li>
  678. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  679. </ul>
  680. </div>
  681. </div>
  682. <a class="anchor" id="ga11e3df32a66d5240b277375cbb5d3c83"></a>
  683. <div class="memitem">
  684. <div class="memproto">
  685. <table class="memname">
  686. <tr>
  687. <td class="memname">void EvrRtxMessageQueueGetPending </td>
  688. <td>(</td>
  689. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  690. <td class="paramname"><em>mq_id</em>, </td>
  691. </tr>
  692. <tr>
  693. <td class="paramkey"></td>
  694. <td></td>
  695. <td class="paramtype">void *&#160;</td>
  696. <td class="paramname"><em>msg_ptr</em>, </td>
  697. </tr>
  698. <tr>
  699. <td class="paramkey"></td>
  700. <td></td>
  701. <td class="paramtype">uint32_t&#160;</td>
  702. <td class="paramname"><em>timeout</em>&#160;</td>
  703. </tr>
  704. <tr>
  705. <td></td>
  706. <td>)</td>
  707. <td></td><td></td>
  708. </tr>
  709. </table>
  710. </div><div class="memdoc">
  711. <dl class="params"><dt>Parameters</dt><dd>
  712. <table class="params">
  713. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  714. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue. </td></tr>
  715. <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr>
  716. </table>
  717. </dd>
  718. </dl>
  719. <p>The event <b>MessageQueueGetPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> starts waiting for message to be retrieved from the queue.</p>
  720. <p><b>Value</b> in the Event Recorder shows:</p>
  721. <ul>
  722. <li><b>mq_id</b> : message queue ID.</li>
  723. <li><b>msg_ptr</b> : memory address of buffer for message.</li>
  724. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  725. </ul>
  726. </div>
  727. </div>
  728. <a class="anchor" id="ga5e699de7401c46fd0e8bc19e398dc5a8"></a>
  729. <div class="memitem">
  730. <div class="memproto">
  731. <table class="memname">
  732. <tr>
  733. <td class="memname">void EvrRtxMessageQueueGetTimeout </td>
  734. <td>(</td>
  735. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  736. <td class="paramname"><em>mq_id</em></td><td>)</td>
  737. <td></td>
  738. </tr>
  739. </table>
  740. </div><div class="memdoc">
  741. <dl class="params"><dt>Parameters</dt><dd>
  742. <table class="params">
  743. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr>
  744. </table>
  745. </dd>
  746. </dl>
  747. <p>The event <b>MessageQueueGetTimeout</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> is called and there is no message available in queue until timeout expires.</p>
  748. <p><b>Value</b> in the Event Recorder shows:</p>
  749. <ul>
  750. <li><b>mq_id</b> : message queue ID. </li>
  751. </ul>
  752. </div>
  753. </div>
  754. <a class="anchor" id="gab340b38df5d8bf2a1182fd18f2d3a6c4"></a>
  755. <div class="memitem">
  756. <div class="memproto">
  757. <table class="memname">
  758. <tr>
  759. <td class="memname">void EvrRtxMessageQueueRetrieved </td>
  760. <td>(</td>
  761. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  762. <td class="paramname"><em>mq_id</em>, </td>
  763. </tr>
  764. <tr>
  765. <td class="paramkey"></td>
  766. <td></td>
  767. <td class="paramtype">void *&#160;</td>
  768. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  769. </tr>
  770. <tr>
  771. <td></td>
  772. <td>)</td>
  773. <td></td><td></td>
  774. </tr>
  775. </table>
  776. </div><div class="memdoc">
  777. <dl class="params"><dt>Parameters</dt><dd>
  778. <table class="params">
  779. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  780. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue.</td></tr>
  781. </table>
  782. </dd>
  783. </dl>
  784. <p>The event <b>MessageQueueRetrieved</b> is generated when message is retrieved from the message queue.</p>
  785. <p><b>Value</b> in the Event Recorder shows:</p>
  786. <ul>
  787. <li><b>mq_id</b> : message queue ID.</li>
  788. <li><b>msg_ptr</b> : memory address of buffer for message. </li>
  789. </ul>
  790. </div>
  791. </div>
  792. <a class="anchor" id="ga22bfb7d1c2f6e3e9fea9d3267b2d6988"></a>
  793. <div class="memitem">
  794. <div class="memproto">
  795. <table class="memname">
  796. <tr>
  797. <td class="memname">void EvrRtxMessageQueueNotRetrieved </td>
  798. <td>(</td>
  799. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  800. <td class="paramname"><em>mq_id</em>, </td>
  801. </tr>
  802. <tr>
  803. <td class="paramkey"></td>
  804. <td></td>
  805. <td class="paramtype">void *&#160;</td>
  806. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  807. </tr>
  808. <tr>
  809. <td></td>
  810. <td>)</td>
  811. <td></td><td></td>
  812. </tr>
  813. </table>
  814. </div><div class="memdoc">
  815. <dl class="params"><dt>Parameters</dt><dd>
  816. <table class="params">
  817. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  818. <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue.</td></tr>
  819. </table>
  820. </dd>
  821. </dl>
  822. <p>The event <b>MessageQueueNotRetrieved</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> is called without the wait timeout and there is no message available in queue.</p>
  823. <p><b>Value</b> in the Event Recorder shows:</p>
  824. <ul>
  825. <li><b>mq_id</b> : message queue ID.</li>
  826. <li><b>msg_ptr</b> : memory address of buffer for message. </li>
  827. </ul>
  828. </div>
  829. </div>
  830. <a class="anchor" id="gad423a0be13d65e98d9ae08de9c399615"></a>
  831. <div class="memitem">
  832. <div class="memproto">
  833. <table class="memname">
  834. <tr>
  835. <td class="memname">void EvrRtxMessageQueueGetCapacity </td>
  836. <td>(</td>
  837. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  838. <td class="paramname"><em>mq_id</em>, </td>
  839. </tr>
  840. <tr>
  841. <td class="paramkey"></td>
  842. <td></td>
  843. <td class="paramtype">uint32_t&#160;</td>
  844. <td class="paramname"><em>capacity</em>&#160;</td>
  845. </tr>
  846. <tr>
  847. <td></td>
  848. <td>)</td>
  849. <td></td><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">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  856. <tr><td class="paramdir">[in]</td><td class="paramname">capacity</td><td>maximum number of messages.</td></tr>
  857. </table>
  858. </dd>
  859. </dl>
  860. <p>The event <b>MessageQueueGetCapacity</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gac24f87d4f395e9e9c900c320e45ade8a">osMessageQueueGetCapacity</a> is called and its execution result is known.</p>
  861. <p><b>Value</b> in the Event Recorder shows:</p>
  862. <ul>
  863. <li><b>mq_id</b> : message queue ID.</li>
  864. <li><b>capacity</b> : retrieved maximum number of messages (0 in case of a failure). </li>
  865. </ul>
  866. </div>
  867. </div>
  868. <a class="anchor" id="ga3d6348bed3937de29765ed4d7d07fac8"></a>
  869. <div class="memitem">
  870. <div class="memproto">
  871. <table class="memname">
  872. <tr>
  873. <td class="memname">void EvrRtxMessageQueueGetMsgSize </td>
  874. <td>(</td>
  875. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  876. <td class="paramname"><em>mq_id</em>, </td>
  877. </tr>
  878. <tr>
  879. <td class="paramkey"></td>
  880. <td></td>
  881. <td class="paramtype">uint32_t&#160;</td>
  882. <td class="paramname"><em>msg_size</em>&#160;</td>
  883. </tr>
  884. <tr>
  885. <td></td>
  886. <td>)</td>
  887. <td></td><td></td>
  888. </tr>
  889. </table>
  890. </div><div class="memdoc">
  891. <dl class="params"><dt>Parameters</dt><dd>
  892. <table class="params">
  893. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  894. <tr><td class="paramdir">[in]</td><td class="paramname">msg_size</td><td>maximum message size in bytes.</td></tr>
  895. </table>
  896. </dd>
  897. </dl>
  898. <p>The event <b>MessageQueueGetMsgSize</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga96d3d84069b20359de48109e28a1a89e">osMessageQueueGetMsgSize</a> is called and its execution result is known.</p>
  899. <p><b>Value</b> in the Event Recorder shows:</p>
  900. <ul>
  901. <li><b>mq_id</b> : message queue ID.</li>
  902. <li><b>msg_size</b> : retrieved maximum message size in bytes (0 in case of a failure). </li>
  903. </ul>
  904. </div>
  905. </div>
  906. <a class="anchor" id="ga145f0c464382dc71ff3b1c624b8bd570"></a>
  907. <div class="memitem">
  908. <div class="memproto">
  909. <table class="memname">
  910. <tr>
  911. <td class="memname">void EvrRtxMessageQueueGetCount </td>
  912. <td>(</td>
  913. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  914. <td class="paramname"><em>mq_id</em>, </td>
  915. </tr>
  916. <tr>
  917. <td class="paramkey"></td>
  918. <td></td>
  919. <td class="paramtype">uint32_t&#160;</td>
  920. <td class="paramname"><em>count</em>&#160;</td>
  921. </tr>
  922. <tr>
  923. <td></td>
  924. <td>)</td>
  925. <td></td><td></td>
  926. </tr>
  927. </table>
  928. </div><div class="memdoc">
  929. <dl class="params"><dt>Parameters</dt><dd>
  930. <table class="params">
  931. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  932. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>number of queued messages.</td></tr>
  933. </table>
  934. </dd>
  935. </dl>
  936. <p>The event <b>MessageQueueGetCount</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga6a32ac394fcff568b251c160cc3014b2">osMessageQueueGetCount</a> is called and its execution result is known.</p>
  937. <p><b>Value</b> in the Event Recorder shows:</p>
  938. <ul>
  939. <li><b>mq_id</b> : message queue ID.</li>
  940. <li><b>count</b> : retrieved number of queued messages (0 in case of a failure). </li>
  941. </ul>
  942. </div>
  943. </div>
  944. <a class="anchor" id="ga6cfce7336f58505a2379a8a71f477d2f"></a>
  945. <div class="memitem">
  946. <div class="memproto">
  947. <table class="memname">
  948. <tr>
  949. <td class="memname">void EvrRtxMessageQueueGetSpace </td>
  950. <td>(</td>
  951. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  952. <td class="paramname"><em>mq_id</em>, </td>
  953. </tr>
  954. <tr>
  955. <td class="paramkey"></td>
  956. <td></td>
  957. <td class="paramtype">uint32_t&#160;</td>
  958. <td class="paramname"><em>space</em>&#160;</td>
  959. </tr>
  960. <tr>
  961. <td></td>
  962. <td>)</td>
  963. <td></td><td></td>
  964. </tr>
  965. </table>
  966. </div><div class="memdoc">
  967. <dl class="params"><dt>Parameters</dt><dd>
  968. <table class="params">
  969. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr>
  970. <tr><td class="paramdir">[in]</td><td class="paramname">space</td><td>number of available slots for messages.</td></tr>
  971. </table>
  972. </dd>
  973. </dl>
  974. <p>The event <b>MessageQueueGetSpace</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaddf0904427436dd3880d46263c2dc9fa">osMessageQueueGetSpace</a> is called and its execution result is known.</p>
  975. <p><b>Value</b> in the Event Recorder shows:</p>
  976. <ul>
  977. <li><b>mq_id</b> : message queue ID.</li>
  978. <li><b>space</b> : retrieved number of available slots for messages (0 in case of a failure). </li>
  979. </ul>
  980. </div>
  981. </div>
  982. <a class="anchor" id="ga91b8c8630c7d89b6b6dbb74d4fc81ba4"></a>
  983. <div class="memitem">
  984. <div class="memproto">
  985. <table class="memname">
  986. <tr>
  987. <td class="memname">void EvrRtxMessageQueueReset </td>
  988. <td>(</td>
  989. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  990. <td class="paramname"><em>mq_id</em></td><td>)</td>
  991. <td></td>
  992. </tr>
  993. </table>
  994. </div><div class="memdoc">
  995. <dl class="params"><dt>Parameters</dt><dd>
  996. <table class="params">
  997. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr>
  998. </table>
  999. </dd>
  1000. </dl>
  1001. <p>The event <b>MessageQueueReset</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gac6dce7f9ad132d266292c2e979d861b4">osMessageQueueReset</a> is called.</p>
  1002. <p><b>Value</b> in the Event Recorder shows:</p>
  1003. <ul>
  1004. <li><b>mq_id</b> : message queue ID. </li>
  1005. </ul>
  1006. </div>
  1007. </div>
  1008. <a class="anchor" id="ga3947d4a7ac86ee7a50052c9eb4cd5432"></a>
  1009. <div class="memitem">
  1010. <div class="memproto">
  1011. <table class="memname">
  1012. <tr>
  1013. <td class="memname">void EvrRtxMessageQueueResetDone </td>
  1014. <td>(</td>
  1015. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  1016. <td class="paramname"><em>mq_id</em></td><td>)</td>
  1017. <td></td>
  1018. </tr>
  1019. </table>
  1020. </div><div class="memdoc">
  1021. <dl class="params"><dt>Parameters</dt><dd>
  1022. <table class="params">
  1023. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr>
  1024. </table>
  1025. </dd>
  1026. </dl>
  1027. <p>The event <b>MessageQueueResetDone</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gac6dce7f9ad132d266292c2e979d861b4">osMessageQueueReset</a> successfully completes message queue reset.</p>
  1028. <p><b>Value</b> in the Event Recorder shows:</p>
  1029. <ul>
  1030. <li><b>mq_id</b> : message queue ID. </li>
  1031. </ul>
  1032. </div>
  1033. </div>
  1034. <a class="anchor" id="gad11606ef82f5b82f291bf64adfc805e4"></a>
  1035. <div class="memitem">
  1036. <div class="memproto">
  1037. <table class="memname">
  1038. <tr>
  1039. <td class="memname">void EvrRtxMessageQueueDelete </td>
  1040. <td>(</td>
  1041. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  1042. <td class="paramname"><em>mq_id</em></td><td>)</td>
  1043. <td></td>
  1044. </tr>
  1045. </table>
  1046. </div><div class="memdoc">
  1047. <dl class="params"><dt>Parameters</dt><dd>
  1048. <table class="params">
  1049. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr>
  1050. </table>
  1051. </dd>
  1052. </dl>
  1053. <p>The event <b>MessageQueueDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaba987f665444e0d83fa6a3a68bc72abe">osMessageQueueDelete</a> is called.</p>
  1054. <p><b>Value</b> in the Event Recorder shows:</p>
  1055. <ul>
  1056. <li><b>mq_id</b> : message queue ID. </li>
  1057. </ul>
  1058. </div>
  1059. </div>
  1060. <a class="anchor" id="ga3bbf02128c31e5cc7ef4c78cdbec508c"></a>
  1061. <div class="memitem">
  1062. <div class="memproto">
  1063. <table class="memname">
  1064. <tr>
  1065. <td class="memname">void EvrRtxMessageQueueDestroyed </td>
  1066. <td>(</td>
  1067. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  1068. <td class="paramname"><em>mq_id</em></td><td>)</td>
  1069. <td></td>
  1070. </tr>
  1071. </table>
  1072. </div><div class="memdoc">
  1073. <dl class="params"><dt>Parameters</dt><dd>
  1074. <table class="params">
  1075. <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr>
  1076. </table>
  1077. </dd>
  1078. </dl>
  1079. <p>The event <b>MessageQueueDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaba987f665444e0d83fa6a3a68bc72abe">osMessageQueueDelete</a> successfully deletes the message queue object.</p>
  1080. <p><b>Value</b> in the Event Recorder shows:</p>
  1081. <ul>
  1082. <li><b>mq_id</b> : message queue ID. </li>
  1083. </ul>
  1084. </div>
  1085. </div>
  1086. </div><!-- contents -->
  1087. </div><!-- doc-content -->
  1088. <!-- start footer part -->
  1089. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  1090. <ul>
  1091. <li class="footer">Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  1092. <!--
  1093. <a href="http://www.doxygen.org/index.html">
  1094. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  1095. -->
  1096. </li>
  1097. </ul>
  1098. </div>
  1099. </body>
  1100. </html>