group__rtx__evr__message__queue.html 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125
  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. </div>
  311. </div>
  312. <a class="anchor" id="ga36d6982377c1f54a227ba6fbb9458b79"></a>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">void EvrRtxMessageQueueCreated </td>
  318. <td>(</td>
  319. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  320. <td class="paramname"><em>mq_id</em>, </td>
  321. </tr>
  322. <tr>
  323. <td class="paramkey"></td>
  324. <td></td>
  325. <td class="paramtype">const char *&#160;</td>
  326. <td class="paramname"><em>name</em>&#160;</td>
  327. </tr>
  328. <tr>
  329. <td></td>
  330. <td>)</td>
  331. <td></td><td></td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <dl class="params"><dt>Parameters</dt><dd>
  336. <table class="params">
  337. <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>
  338. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to message queue object name.</td></tr>
  339. </table>
  340. </dd>
  341. </dl>
  342. <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>
  343. <p><b>Value</b> in the Event Recorder shows:</p>
  344. <ul>
  345. <li><b>mq_id</b> : message queue ID. </li>
  346. </ul>
  347. </div>
  348. </div>
  349. <a class="anchor" id="gad0ef8ee59d2ec189351c5884f5f8e945"></a>
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">void EvrRtxMessageQueueGetName </td>
  355. <td>(</td>
  356. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  357. <td class="paramname"><em>mq_id</em>, </td>
  358. </tr>
  359. <tr>
  360. <td class="paramkey"></td>
  361. <td></td>
  362. <td class="paramtype">const char *&#160;</td>
  363. <td class="paramname"><em>name</em>&#160;</td>
  364. </tr>
  365. <tr>
  366. <td></td>
  367. <td>)</td>
  368. <td></td><td></td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. <dl class="params"><dt>Parameters</dt><dd>
  373. <table class="params">
  374. <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>
  375. <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to message queue object name.</td></tr>
  376. </table>
  377. </dd>
  378. </dl>
  379. <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>
  380. <p><b>Value</b> in the Event Recorder shows:</p>
  381. <ul>
  382. <li><b>mq_id</b> : message queue ID.</li>
  383. <li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li>
  384. </ul>
  385. </div>
  386. </div>
  387. <a class="anchor" id="ga401536a603e5a805cc6089b4de11d3d3"></a>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">void EvrRtxMessageQueuePut </td>
  393. <td>(</td>
  394. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  395. <td class="paramname"><em>mq_id</em>, </td>
  396. </tr>
  397. <tr>
  398. <td class="paramkey"></td>
  399. <td></td>
  400. <td class="paramtype">const void *&#160;</td>
  401. <td class="paramname"><em>msg_ptr</em>, </td>
  402. </tr>
  403. <tr>
  404. <td class="paramkey"></td>
  405. <td></td>
  406. <td class="paramtype">uint8_t&#160;</td>
  407. <td class="paramname"><em>msg_prio</em>, </td>
  408. </tr>
  409. <tr>
  410. <td class="paramkey"></td>
  411. <td></td>
  412. <td class="paramtype">uint32_t&#160;</td>
  413. <td class="paramname"><em>timeout</em>&#160;</td>
  414. </tr>
  415. <tr>
  416. <td></td>
  417. <td>)</td>
  418. <td></td><td></td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. <dl class="params"><dt>Parameters</dt><dd>
  423. <table class="params">
  424. <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>
  425. <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>
  426. <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr>
  427. <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>
  428. </table>
  429. </dd>
  430. </dl>
  431. <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>
  432. <p><b>Value</b> in the Event Recorder shows:</p>
  433. <ul>
  434. <li><b>mq_id</b> : message queue ID.</li>
  435. <li><b>msg_ptr</b> : memory address of message buffer.</li>
  436. <li><b>msg_prio</b> : message priority.</li>
  437. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  438. </ul>
  439. </div>
  440. </div>
  441. <a class="anchor" id="ga4b1b6191c6ca87dff4714e25b5845828"></a>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="memname">
  445. <tr>
  446. <td class="memname">void EvrRtxMessageQueuePutPending </td>
  447. <td>(</td>
  448. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  449. <td class="paramname"><em>mq_id</em>, </td>
  450. </tr>
  451. <tr>
  452. <td class="paramkey"></td>
  453. <td></td>
  454. <td class="paramtype">const void *&#160;</td>
  455. <td class="paramname"><em>msg_ptr</em>, </td>
  456. </tr>
  457. <tr>
  458. <td class="paramkey"></td>
  459. <td></td>
  460. <td class="paramtype">uint32_t&#160;</td>
  461. <td class="paramname"><em>timeout</em>&#160;</td>
  462. </tr>
  463. <tr>
  464. <td></td>
  465. <td>)</td>
  466. <td></td><td></td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <dl class="params"><dt>Parameters</dt><dd>
  471. <table class="params">
  472. <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>
  473. <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>
  474. <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>
  475. </table>
  476. </dd>
  477. </dl>
  478. <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>
  479. <p><b>Value</b> in the Event Recorder shows:</p>
  480. <ul>
  481. <li><b>mq_id</b> : message queue ID.</li>
  482. <li><b>msg_ptr</b> : memory address of message buffer.</li>
  483. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  484. </ul>
  485. </div>
  486. </div>
  487. <a class="anchor" id="ga7394ca2d88255470f7ba0bb2bff12e99"></a>
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="memname">
  491. <tr>
  492. <td class="memname">void EvrRtxMessageQueuePutTimeout </td>
  493. <td>(</td>
  494. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  495. <td class="paramname"><em>mq_id</em></td><td>)</td>
  496. <td></td>
  497. </tr>
  498. </table>
  499. </div><div class="memdoc">
  500. <dl class="params"><dt>Parameters</dt><dd>
  501. <table class="params">
  502. <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>
  503. </table>
  504. </dd>
  505. </dl>
  506. <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>
  507. <p><b>Value</b> in the Event Recorder shows:</p>
  508. <ul>
  509. <li><b>mq_id</b> : message queue ID. </li>
  510. </ul>
  511. </div>
  512. </div>
  513. <a class="anchor" id="ga8440223b9d48145df5505489e7c6f7d9"></a>
  514. <div class="memitem">
  515. <div class="memproto">
  516. <table class="memname">
  517. <tr>
  518. <td class="memname">void EvrRtxMessageQueueInsertPending </td>
  519. <td>(</td>
  520. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  521. <td class="paramname"><em>mq_id</em>, </td>
  522. </tr>
  523. <tr>
  524. <td class="paramkey"></td>
  525. <td></td>
  526. <td class="paramtype">const void *&#160;</td>
  527. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  528. </tr>
  529. <tr>
  530. <td></td>
  531. <td>)</td>
  532. <td></td><td></td>
  533. </tr>
  534. </table>
  535. </div><div class="memdoc">
  536. <dl class="params"><dt>Parameters</dt><dd>
  537. <table class="params">
  538. <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>
  539. <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>
  540. </table>
  541. </dd>
  542. </dl>
  543. <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>
  544. <p><b>Value</b> in the Event Recorder shows:</p>
  545. <ul>
  546. <li><b>mq_id</b> : message queue ID.</li>
  547. <li><b>msg_ptr</b> : memory address of message buffer. </li>
  548. </ul>
  549. </div>
  550. </div>
  551. <a class="anchor" id="gaa30c5b375d4050ad7d99ba094821bf52"></a>
  552. <div class="memitem">
  553. <div class="memproto">
  554. <table class="memname">
  555. <tr>
  556. <td class="memname">void EvrRtxMessageQueueInserted </td>
  557. <td>(</td>
  558. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  559. <td class="paramname"><em>mq_id</em>, </td>
  560. </tr>
  561. <tr>
  562. <td class="paramkey"></td>
  563. <td></td>
  564. <td class="paramtype">const void *&#160;</td>
  565. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  566. </tr>
  567. <tr>
  568. <td></td>
  569. <td>)</td>
  570. <td></td><td></td>
  571. </tr>
  572. </table>
  573. </div><div class="memdoc">
  574. <dl class="params"><dt>Parameters</dt><dd>
  575. <table class="params">
  576. <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>
  577. <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>
  578. </table>
  579. </dd>
  580. </dl>
  581. <p>The event <b>MessageQueueInserted</b> is generated when a message is successfully inserted into the queue.</p>
  582. <p><b>Value</b> in the Event Recorder shows:</p>
  583. <ul>
  584. <li><b>mq_id</b> : message queue ID.</li>
  585. <li><b>msg_ptr</b> : memory address of message buffer. </li>
  586. </ul>
  587. </div>
  588. </div>
  589. <a class="anchor" id="ga2922125d8ac63fd800dc3b7888fd3f3c"></a>
  590. <div class="memitem">
  591. <div class="memproto">
  592. <table class="memname">
  593. <tr>
  594. <td class="memname">void EvrRtxMessageQueueNotInserted </td>
  595. <td>(</td>
  596. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  597. <td class="paramname"><em>mq_id</em>, </td>
  598. </tr>
  599. <tr>
  600. <td class="paramkey"></td>
  601. <td></td>
  602. <td class="paramtype">const void *&#160;</td>
  603. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  604. </tr>
  605. <tr>
  606. <td></td>
  607. <td>)</td>
  608. <td></td><td></td>
  609. </tr>
  610. </table>
  611. </div><div class="memdoc">
  612. <dl class="params"><dt>Parameters</dt><dd>
  613. <table class="params">
  614. <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>
  615. <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>
  616. </table>
  617. </dd>
  618. </dl>
  619. <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>
  620. <p><b>Value</b> in the Event Recorder shows:</p>
  621. <ul>
  622. <li><b>mq_id</b> : message queue ID.</li>
  623. <li><b>msg_ptr</b> : memory address of message buffer. </li>
  624. </ul>
  625. </div>
  626. </div>
  627. <a class="anchor" id="ga0826c1d05d3a99afb8682f0ca3f7fd62"></a>
  628. <div class="memitem">
  629. <div class="memproto">
  630. <table class="memname">
  631. <tr>
  632. <td class="memname">void EvrRtxMessageQueueGet </td>
  633. <td>(</td>
  634. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  635. <td class="paramname"><em>mq_id</em>, </td>
  636. </tr>
  637. <tr>
  638. <td class="paramkey"></td>
  639. <td></td>
  640. <td class="paramtype">void *&#160;</td>
  641. <td class="paramname"><em>msg_ptr</em>, </td>
  642. </tr>
  643. <tr>
  644. <td class="paramkey"></td>
  645. <td></td>
  646. <td class="paramtype">uint8_t *&#160;</td>
  647. <td class="paramname"><em>msg_prio</em>, </td>
  648. </tr>
  649. <tr>
  650. <td class="paramkey"></td>
  651. <td></td>
  652. <td class="paramtype">uint32_t&#160;</td>
  653. <td class="paramname"><em>timeout</em>&#160;</td>
  654. </tr>
  655. <tr>
  656. <td></td>
  657. <td>)</td>
  658. <td></td><td></td>
  659. </tr>
  660. </table>
  661. </div><div class="memdoc">
  662. <dl class="params"><dt>Parameters</dt><dd>
  663. <table class="params">
  664. <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>
  665. <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>
  666. <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr>
  667. <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>
  668. </table>
  669. </dd>
  670. </dl>
  671. <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>
  672. <p><b>Value</b> in the Event Recorder shows:</p>
  673. <ul>
  674. <li><b>mq_id</b> : message queue ID.</li>
  675. <li><b>msg_ptr</b> : memory address of buffer for message.</li>
  676. <li><b>msg_prio</b> : memory address of buffer for message priority.</li>
  677. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  678. </ul>
  679. </div>
  680. </div>
  681. <a class="anchor" id="ga11e3df32a66d5240b277375cbb5d3c83"></a>
  682. <div class="memitem">
  683. <div class="memproto">
  684. <table class="memname">
  685. <tr>
  686. <td class="memname">void EvrRtxMessageQueueGetPending </td>
  687. <td>(</td>
  688. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  689. <td class="paramname"><em>mq_id</em>, </td>
  690. </tr>
  691. <tr>
  692. <td class="paramkey"></td>
  693. <td></td>
  694. <td class="paramtype">void *&#160;</td>
  695. <td class="paramname"><em>msg_ptr</em>, </td>
  696. </tr>
  697. <tr>
  698. <td class="paramkey"></td>
  699. <td></td>
  700. <td class="paramtype">uint32_t&#160;</td>
  701. <td class="paramname"><em>timeout</em>&#160;</td>
  702. </tr>
  703. <tr>
  704. <td></td>
  705. <td>)</td>
  706. <td></td><td></td>
  707. </tr>
  708. </table>
  709. </div><div class="memdoc">
  710. <dl class="params"><dt>Parameters</dt><dd>
  711. <table class="params">
  712. <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>
  713. <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>
  714. <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>
  715. </table>
  716. </dd>
  717. </dl>
  718. <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>
  719. <p><b>Value</b> in the Event Recorder shows:</p>
  720. <ul>
  721. <li><b>mq_id</b> : message queue ID.</li>
  722. <li><b>msg_ptr</b> : memory address of buffer for message.</li>
  723. <li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li>
  724. </ul>
  725. </div>
  726. </div>
  727. <a class="anchor" id="ga5e699de7401c46fd0e8bc19e398dc5a8"></a>
  728. <div class="memitem">
  729. <div class="memproto">
  730. <table class="memname">
  731. <tr>
  732. <td class="memname">void EvrRtxMessageQueueGetTimeout </td>
  733. <td>(</td>
  734. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  735. <td class="paramname"><em>mq_id</em></td><td>)</td>
  736. <td></td>
  737. </tr>
  738. </table>
  739. </div><div class="memdoc">
  740. <dl class="params"><dt>Parameters</dt><dd>
  741. <table class="params">
  742. <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>
  743. </table>
  744. </dd>
  745. </dl>
  746. <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>
  747. <p><b>Value</b> in the Event Recorder shows:</p>
  748. <ul>
  749. <li><b>mq_id</b> : message queue ID. </li>
  750. </ul>
  751. </div>
  752. </div>
  753. <a class="anchor" id="gab340b38df5d8bf2a1182fd18f2d3a6c4"></a>
  754. <div class="memitem">
  755. <div class="memproto">
  756. <table class="memname">
  757. <tr>
  758. <td class="memname">void EvrRtxMessageQueueRetrieved </td>
  759. <td>(</td>
  760. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  761. <td class="paramname"><em>mq_id</em>, </td>
  762. </tr>
  763. <tr>
  764. <td class="paramkey"></td>
  765. <td></td>
  766. <td class="paramtype">void *&#160;</td>
  767. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  768. </tr>
  769. <tr>
  770. <td></td>
  771. <td>)</td>
  772. <td></td><td></td>
  773. </tr>
  774. </table>
  775. </div><div class="memdoc">
  776. <dl class="params"><dt>Parameters</dt><dd>
  777. <table class="params">
  778. <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>
  779. <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>
  780. </table>
  781. </dd>
  782. </dl>
  783. <p>The event <b>MessageQueueRetrieved</b> is generated when message is retrieved from the message queue.</p>
  784. <p><b>Value</b> in the Event Recorder shows:</p>
  785. <ul>
  786. <li><b>mq_id</b> : message queue ID.</li>
  787. <li><b>msg_ptr</b> : memory address of buffer for message. </li>
  788. </ul>
  789. </div>
  790. </div>
  791. <a class="anchor" id="ga22bfb7d1c2f6e3e9fea9d3267b2d6988"></a>
  792. <div class="memitem">
  793. <div class="memproto">
  794. <table class="memname">
  795. <tr>
  796. <td class="memname">void EvrRtxMessageQueueNotRetrieved </td>
  797. <td>(</td>
  798. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  799. <td class="paramname"><em>mq_id</em>, </td>
  800. </tr>
  801. <tr>
  802. <td class="paramkey"></td>
  803. <td></td>
  804. <td class="paramtype">void *&#160;</td>
  805. <td class="paramname"><em>msg_ptr</em>&#160;</td>
  806. </tr>
  807. <tr>
  808. <td></td>
  809. <td>)</td>
  810. <td></td><td></td>
  811. </tr>
  812. </table>
  813. </div><div class="memdoc">
  814. <dl class="params"><dt>Parameters</dt><dd>
  815. <table class="params">
  816. <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>
  817. <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>
  818. </table>
  819. </dd>
  820. </dl>
  821. <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>
  822. <p><b>Value</b> in the Event Recorder shows:</p>
  823. <ul>
  824. <li><b>mq_id</b> : message queue ID.</li>
  825. <li><b>msg_ptr</b> : memory address of buffer for message. </li>
  826. </ul>
  827. </div>
  828. </div>
  829. <a class="anchor" id="gad423a0be13d65e98d9ae08de9c399615"></a>
  830. <div class="memitem">
  831. <div class="memproto">
  832. <table class="memname">
  833. <tr>
  834. <td class="memname">void EvrRtxMessageQueueGetCapacity </td>
  835. <td>(</td>
  836. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  837. <td class="paramname"><em>mq_id</em>, </td>
  838. </tr>
  839. <tr>
  840. <td class="paramkey"></td>
  841. <td></td>
  842. <td class="paramtype">uint32_t&#160;</td>
  843. <td class="paramname"><em>capacity</em>&#160;</td>
  844. </tr>
  845. <tr>
  846. <td></td>
  847. <td>)</td>
  848. <td></td><td></td>
  849. </tr>
  850. </table>
  851. </div><div class="memdoc">
  852. <dl class="params"><dt>Parameters</dt><dd>
  853. <table class="params">
  854. <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>
  855. <tr><td class="paramdir">[in]</td><td class="paramname">capacity</td><td>maximum number of messages.</td></tr>
  856. </table>
  857. </dd>
  858. </dl>
  859. <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>
  860. <p><b>Value</b> in the Event Recorder shows:</p>
  861. <ul>
  862. <li><b>mq_id</b> : message queue ID.</li>
  863. <li><b>capacity</b> : retrieved maximum number of messages (0 in case of a failure). </li>
  864. </ul>
  865. </div>
  866. </div>
  867. <a class="anchor" id="ga3d6348bed3937de29765ed4d7d07fac8"></a>
  868. <div class="memitem">
  869. <div class="memproto">
  870. <table class="memname">
  871. <tr>
  872. <td class="memname">void EvrRtxMessageQueueGetMsgSize </td>
  873. <td>(</td>
  874. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  875. <td class="paramname"><em>mq_id</em>, </td>
  876. </tr>
  877. <tr>
  878. <td class="paramkey"></td>
  879. <td></td>
  880. <td class="paramtype">uint32_t&#160;</td>
  881. <td class="paramname"><em>msg_size</em>&#160;</td>
  882. </tr>
  883. <tr>
  884. <td></td>
  885. <td>)</td>
  886. <td></td><td></td>
  887. </tr>
  888. </table>
  889. </div><div class="memdoc">
  890. <dl class="params"><dt>Parameters</dt><dd>
  891. <table class="params">
  892. <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>
  893. <tr><td class="paramdir">[in]</td><td class="paramname">msg_size</td><td>maximum message size in bytes.</td></tr>
  894. </table>
  895. </dd>
  896. </dl>
  897. <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>
  898. <p><b>Value</b> in the Event Recorder shows:</p>
  899. <ul>
  900. <li><b>mq_id</b> : message queue ID.</li>
  901. <li><b>msg_size</b> : retrieved maximum message size in bytes (0 in case of a failure). </li>
  902. </ul>
  903. </div>
  904. </div>
  905. <a class="anchor" id="ga145f0c464382dc71ff3b1c624b8bd570"></a>
  906. <div class="memitem">
  907. <div class="memproto">
  908. <table class="memname">
  909. <tr>
  910. <td class="memname">void EvrRtxMessageQueueGetCount </td>
  911. <td>(</td>
  912. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  913. <td class="paramname"><em>mq_id</em>, </td>
  914. </tr>
  915. <tr>
  916. <td class="paramkey"></td>
  917. <td></td>
  918. <td class="paramtype">uint32_t&#160;</td>
  919. <td class="paramname"><em>count</em>&#160;</td>
  920. </tr>
  921. <tr>
  922. <td></td>
  923. <td>)</td>
  924. <td></td><td></td>
  925. </tr>
  926. </table>
  927. </div><div class="memdoc">
  928. <dl class="params"><dt>Parameters</dt><dd>
  929. <table class="params">
  930. <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>
  931. <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>number of queued messages.</td></tr>
  932. </table>
  933. </dd>
  934. </dl>
  935. <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>
  936. <p><b>Value</b> in the Event Recorder shows:</p>
  937. <ul>
  938. <li><b>mq_id</b> : message queue ID.</li>
  939. <li><b>count</b> : retrieved number of queued messages (0 in case of a failure). </li>
  940. </ul>
  941. </div>
  942. </div>
  943. <a class="anchor" id="ga6cfce7336f58505a2379a8a71f477d2f"></a>
  944. <div class="memitem">
  945. <div class="memproto">
  946. <table class="memname">
  947. <tr>
  948. <td class="memname">void EvrRtxMessageQueueGetSpace </td>
  949. <td>(</td>
  950. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  951. <td class="paramname"><em>mq_id</em>, </td>
  952. </tr>
  953. <tr>
  954. <td class="paramkey"></td>
  955. <td></td>
  956. <td class="paramtype">uint32_t&#160;</td>
  957. <td class="paramname"><em>space</em>&#160;</td>
  958. </tr>
  959. <tr>
  960. <td></td>
  961. <td>)</td>
  962. <td></td><td></td>
  963. </tr>
  964. </table>
  965. </div><div class="memdoc">
  966. <dl class="params"><dt>Parameters</dt><dd>
  967. <table class="params">
  968. <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>
  969. <tr><td class="paramdir">[in]</td><td class="paramname">space</td><td>number of available slots for messages.</td></tr>
  970. </table>
  971. </dd>
  972. </dl>
  973. <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>
  974. <p><b>Value</b> in the Event Recorder shows:</p>
  975. <ul>
  976. <li><b>mq_id</b> : message queue ID.</li>
  977. <li><b>space</b> : retrieved number of available slots for messages (0 in case of a failure). </li>
  978. </ul>
  979. </div>
  980. </div>
  981. <a class="anchor" id="ga91b8c8630c7d89b6b6dbb74d4fc81ba4"></a>
  982. <div class="memitem">
  983. <div class="memproto">
  984. <table class="memname">
  985. <tr>
  986. <td class="memname">void EvrRtxMessageQueueReset </td>
  987. <td>(</td>
  988. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  989. <td class="paramname"><em>mq_id</em></td><td>)</td>
  990. <td></td>
  991. </tr>
  992. </table>
  993. </div><div class="memdoc">
  994. <dl class="params"><dt>Parameters</dt><dd>
  995. <table class="params">
  996. <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>
  997. </table>
  998. </dd>
  999. </dl>
  1000. <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>
  1001. <p><b>Value</b> in the Event Recorder shows:</p>
  1002. <ul>
  1003. <li><b>mq_id</b> : message queue ID. </li>
  1004. </ul>
  1005. </div>
  1006. </div>
  1007. <a class="anchor" id="ga3947d4a7ac86ee7a50052c9eb4cd5432"></a>
  1008. <div class="memitem">
  1009. <div class="memproto">
  1010. <table class="memname">
  1011. <tr>
  1012. <td class="memname">void EvrRtxMessageQueueResetDone </td>
  1013. <td>(</td>
  1014. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  1015. <td class="paramname"><em>mq_id</em></td><td>)</td>
  1016. <td></td>
  1017. </tr>
  1018. </table>
  1019. </div><div class="memdoc">
  1020. <dl class="params"><dt>Parameters</dt><dd>
  1021. <table class="params">
  1022. <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>
  1023. </table>
  1024. </dd>
  1025. </dl>
  1026. <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>
  1027. <p><b>Value</b> in the Event Recorder shows:</p>
  1028. <ul>
  1029. <li><b>mq_id</b> : message queue ID. </li>
  1030. </ul>
  1031. </div>
  1032. </div>
  1033. <a class="anchor" id="gad11606ef82f5b82f291bf64adfc805e4"></a>
  1034. <div class="memitem">
  1035. <div class="memproto">
  1036. <table class="memname">
  1037. <tr>
  1038. <td class="memname">void EvrRtxMessageQueueDelete </td>
  1039. <td>(</td>
  1040. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  1041. <td class="paramname"><em>mq_id</em></td><td>)</td>
  1042. <td></td>
  1043. </tr>
  1044. </table>
  1045. </div><div class="memdoc">
  1046. <dl class="params"><dt>Parameters</dt><dd>
  1047. <table class="params">
  1048. <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>
  1049. </table>
  1050. </dd>
  1051. </dl>
  1052. <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>
  1053. <p><b>Value</b> in the Event Recorder shows:</p>
  1054. <ul>
  1055. <li><b>mq_id</b> : message queue ID. </li>
  1056. </ul>
  1057. </div>
  1058. </div>
  1059. <a class="anchor" id="ga3bbf02128c31e5cc7ef4c78cdbec508c"></a>
  1060. <div class="memitem">
  1061. <div class="memproto">
  1062. <table class="memname">
  1063. <tr>
  1064. <td class="memname">void EvrRtxMessageQueueDestroyed </td>
  1065. <td>(</td>
  1066. <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
  1067. <td class="paramname"><em>mq_id</em></td><td>)</td>
  1068. <td></td>
  1069. </tr>
  1070. </table>
  1071. </div><div class="memdoc">
  1072. <dl class="params"><dt>Parameters</dt><dd>
  1073. <table class="params">
  1074. <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>
  1075. </table>
  1076. </dd>
  1077. </dl>
  1078. <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>
  1079. <p><b>Value</b> in the Event Recorder shows:</p>
  1080. <ul>
  1081. <li><b>mq_id</b> : message queue ID. </li>
  1082. </ul>
  1083. </div>
  1084. </div>
  1085. </div><!-- contents -->
  1086. </div><!-- doc-content -->
  1087. <!-- start footer part -->
  1088. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  1089. <ul>
  1090. <li class="footer">Generated on Mon Mar 18 2019 16:06:33 for CMSIS-RTOS2 by Arm Ltd. All rights reserved.
  1091. <!--
  1092. <a href="http://www.doxygen.org/index.html">
  1093. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  1094. -->
  1095. </li>
  1096. </ul>
  1097. </div>
  1098. </body>
  1099. </html>