begriffs open source - cmsis/blob - main/RTOS2/html/group__CMSIS__RTOS__Message.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-RTOS2: Message Queue</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-RTOS2
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this, "CMSIS-RTOS2");
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Real-Time Operating System API</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__CMSIS__RTOS__Message.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#nested-classes">Data Structures</a> &#124;
 132 <a href="#func-members">Functions</a>  </div>
 133   <div class="headertitle"><div class="title">Message Queue<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS API v2</a></div></div></div>
 134 </div><!--header-->
 135 <div class="contents">
 136
 137 <p>Exchange messages between threads in a FIFO-like operation.
 138 <a href="#details">More...</a></p>
 139 <table class="memberdecls">
 140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 141 Data Structures</h2></td></tr>
 142 <tr class="memitem:structosMessageQueueAttr__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">osMessageQueueAttr_t</a></td></tr>
 143 <tr class="memdesc:structosMessageQueueAttr__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attributes structure for message queue.  <a href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">More...</a><br /></td></tr>
 144 <tr class="separator:structosMessageQueueAttr__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 </table><table class="memberdecls">
 146 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 147 Functions</h2></td></tr>
 148 <tr class="memitem:ga24e895a00f9d484db33aaf784c57bfed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</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>
 149 <tr class="memdesc:ga24e895a00f9d484db33aaf784c57bfed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and Initialize a Message Queue object.  <br /></td></tr>
 150 <tr class="separator:ga24e895a00f9d484db33aaf784c57bfed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:gae7cf7bf2b97a5ae481fb60fcce99247a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#gae7cf7bf2b97a5ae481fb60fcce99247a">osMessageQueueGetName</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
 152 <tr class="memdesc:gae7cf7bf2b97a5ae481fb60fcce99247a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get name of a Message Queue object.  <br /></td></tr>
 153 <tr class="separator:gae7cf7bf2b97a5ae481fb60fcce99247a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:gaa515fc8b956f721a8f72b2c505813bfc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</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>
 155 <tr class="memdesc:gaa515fc8b956f721a8f72b2c505813bfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Put a Message into a Queue or timeout if Queue is full.  <br /></td></tr>
 156 <tr class="separator:gaa515fc8b956f721a8f72b2c505813bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:gad90d4959466a7a65105061da8256ab9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</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>
 158 <tr class="memdesc:gad90d4959466a7a65105061da8256ab9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a Message from a Queue or timeout if Queue is empty.  <br /></td></tr>
 159 <tr class="separator:gad90d4959466a7a65105061da8256ab9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:gac24f87d4f395e9e9c900c320e45ade8a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#gac24f87d4f395e9e9c900c320e45ade8a">osMessageQueueGetCapacity</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
 161 <tr class="memdesc:gac24f87d4f395e9e9c900c320e45ade8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get maximum number of messages in a Message Queue.  <br /></td></tr>
 162 <tr class="separator:gac24f87d4f395e9e9c900c320e45ade8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:ga96d3d84069b20359de48109e28a1a89e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#ga96d3d84069b20359de48109e28a1a89e">osMessageQueueGetMsgSize</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
 164 <tr class="memdesc:ga96d3d84069b20359de48109e28a1a89e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get maximum message size in a Message Queue.  <br /></td></tr>
 165 <tr class="separator:ga96d3d84069b20359de48109e28a1a89e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:ga6a32ac394fcff568b251c160cc3014b2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#ga6a32ac394fcff568b251c160cc3014b2">osMessageQueueGetCount</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
 167 <tr class="memdesc:ga6a32ac394fcff568b251c160cc3014b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of queued messages in a Message Queue.  <br /></td></tr>
 168 <tr class="separator:ga6a32ac394fcff568b251c160cc3014b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <tr class="memitem:gaddf0904427436dd3880d46263c2dc9fa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#gaddf0904427436dd3880d46263c2dc9fa">osMessageQueueGetSpace</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
 170 <tr class="memdesc:gaddf0904427436dd3880d46263c2dc9fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of available slots for messages in a Message Queue.  <br /></td></tr>
 171 <tr class="separator:gaddf0904427436dd3880d46263c2dc9fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:gac6dce7f9ad132d266292c2e979d861b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#gac6dce7f9ad132d266292c2e979d861b4">osMessageQueueReset</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
 173 <tr class="memdesc:gac6dce7f9ad132d266292c2e979d861b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset a Message Queue to initial empty state.  <br /></td></tr>
 174 <tr class="separator:gac6dce7f9ad132d266292c2e979d861b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <tr class="memitem:gaba987f665444e0d83fa6a3a68bc72abe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__CMSIS__RTOS__Message.html#gaba987f665444e0d83fa6a3a68bc72abe">osMessageQueueDelete</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr>
 176 <tr class="memdesc:gaba987f665444e0d83fa6a3a68bc72abe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a Message Queue object.  <br /></td></tr>
 177 <tr class="separator:gaba987f665444e0d83fa6a3a68bc72abe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 </table>
 179 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 180 <p><b>Message</b> <b>passing</b> is another basic communication model between threads. In the message passing model, one thread sends data explicitly, while another thread receives it. The operation is more like some kind of I/O rather than a direct access to information to be shared. In CMSIS-RTOS, this mechanism is called s <b>message</b> <b>queue</b>. The data is passed from one thread to another in a FIFO-like operation. Using message queue functions, you can control, send, receive, or wait for messages. The data to be passed can be of integer or pointer type:</p>
 181 <div class="image">
 182 <img src="MessageQueue.png" alt=""/>
 183 <div class="caption">
 184 CMSIS-RTOS Message Queue</div></div>
 185 <p>Compared to a <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</a>, message queues are less efficient in general, but solve a broader range of problems. Sometimes, threads do not have a common address space or the use of shared memory raises problems, such as mutual exclusion.</p>
 186 <dl class="section note"><dt>Note</dt><dd>The functions <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a>, <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a>, <a class="el" href="group__CMSIS__RTOS__Message.html#gac24f87d4f395e9e9c900c320e45ade8a">osMessageQueueGetCapacity</a>, <a class="el" href="group__CMSIS__RTOS__Message.html#ga96d3d84069b20359de48109e28a1a89e">osMessageQueueGetMsgSize</a>, <a class="el" href="group__CMSIS__RTOS__Message.html#ga6a32ac394fcff568b251c160cc3014b2">osMessageQueueGetCount</a>, <a class="el" href="group__CMSIS__RTOS__Message.html#gaddf0904427436dd3880d46263c2dc9fa">osMessageQueueGetSpace</a> can be called from Interrupt Service Routines. </dd>
 187 <dd>
 188 Refer to msgQueueConfig for RTX5 configuration options. </dd></dl>
 189 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 190 <a name="structosMessageQueueAttr__t" id="structosMessageQueueAttr__t"></a>
 191 <h2 class="memtitle"><span class="permalink"><a href="#structosMessageQueueAttr__t">&#9670;&#160;</a></span>osMessageQueueAttr_t</h2>
 192
 193 <div class="memitem">
 194 <div class="memproto">
 195       <table class="memname">
 196         <tr>
 197           <td class="memname">struct osMessageQueueAttr_t</td>
 198         </tr>
 199       </table>
 200 </div><div class="memdoc">
 201 <div class="textblock"><p>Specifies the following attributes for the <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> function. </p>
 202 </div><table class="fieldtable">
 203 <tr><th colspan="3">Data Fields</th></tr>
 204 <tr><td class="fieldtype">
 205 <a id="ab74e6bf80237ddc4109968cedc58c151" name="ab74e6bf80237ddc4109968cedc58c151"></a>const char *</td>
 206 <td class="fieldname">
 207 name</td>
 208 <td class="fielddoc">
 209 name of the message queue <p>Pointer to a constant string with a human readable name (displayed during debugging) of the message queue object.</p>
 210 <p>Default: <span class="XML-Token">NULL</span> no name specified. </p>
 211 </td></tr>
 212 <tr><td class="fieldtype">
 213 <a id="a6e93b49cb79c12f768d72580c7731f30" name="a6e93b49cb79c12f768d72580c7731f30"></a>uint32_t</td>
 214 <td class="fieldname">
 215 attr_bits</td>
 216 <td class="fielddoc">
 217 attribute bits <p>Reserved for future use (must be set to '0' for future compatibility). </p>
 218 </td></tr>
 219 <tr><td class="fieldtype">
 220 <a id="a1e100dc33d403841ed3c344e3397868e" name="a1e100dc33d403841ed3c344e3397868e"></a>void *</td>
 221 <td class="fieldname">
 222 cb_mem</td>
 223 <td class="fielddoc">
 224 memory for control block <p>Pointer to a memory for the message queue control block object. Refer to StaticObjectMemory for more information.</p>
 225 <p>Default: <span class="XML-Token">NULL</span> to use <a class="el" href="group__CMSIS__RTOS__MemoryMgmt.html#CMSIS_RTOS_MemoryMgmt_Automatic">Automatic Dynamic Allocation</a> for the message queue control block. </p>
 226 </td></tr>
 227 <tr><td class="fieldtype">
 228 <a id="aa55a4335d12dc2785dc00fdc292d1159" name="aa55a4335d12dc2785dc00fdc292d1159"></a>uint32_t</td>
 229 <td class="fieldname">
 230 cb_size</td>
 231 <td class="fielddoc">
 232 size of provided memory for control block <p>The size (in bytes) of memory block passed with <a class="el" href="group__CMSIS__RTOS__Message.html#a1e100dc33d403841ed3c344e3397868e">cb_mem</a>. For RTX, the minimum value is defined with osRtxMessageQueueCbSize (higher values are permitted).</p>
 233 <p>Default: <span class="XML-Token">0</span> as the default is no memory provided with <a class="el" href="group__CMSIS__RTOS__Message.html#a1e100dc33d403841ed3c344e3397868e">cb_mem</a>. </p>
 234 </td></tr>
 235 <tr><td class="fieldtype">
 236 <a id="a4e208dc0fb049b42c4b90cbd2791c5ad" name="a4e208dc0fb049b42c4b90cbd2791c5ad"></a>void *</td>
 237 <td class="fieldname">
 238 mq_mem</td>
 239 <td class="fielddoc">
 240 memory for data storage <p>Pointer to a memory for the message queue data. Refer to StaticObjectMemory for more information.</p>
 241 <p>Default: <span class="XML-Token">NULL</span> to use <a class="el" href="group__CMSIS__RTOS__MemoryMgmt.html#CMSIS_RTOS_MemoryMgmt_Automatic">Automatic Dynamic Allocation</a> for the memory pool data. </p>
 242 </td></tr>
 243 <tr><td class="fieldtype">
 244 <a id="ac1cc09f875e20c926920b57bb83c70ee" name="ac1cc09f875e20c926920b57bb83c70ee"></a>uint32_t</td>
 245 <td class="fieldname">
 246 mq_size</td>
 247 <td class="fielddoc">
 248 size of provided memory for data storage <p>The size (in bytes) of memory block passed with <a class="el" href="group__CMSIS__RTOS__Message.html#a4e208dc0fb049b42c4b90cbd2791c5ad">mq_mem</a>. The minimum memory block size is <code>msg_count * msg_size</code> (parameters of the <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> function). The <em>msg_size</em> is rounded up to a double even number to ensure 32-bit alignment of the memory blocks.</p>
 249 <p>Default: 0 as the default is no memory provided with <a class="el" href="group__CMSIS__RTOS__Message.html#a4e208dc0fb049b42c4b90cbd2791c5ad">mq_mem</a>. </p>
 250 </td></tr>
 251 </table>
 252
 253 </div>
 254 </div>
 255 <h2 class="groupheader">Function Documentation</h2>
 256 <a id="ga24e895a00f9d484db33aaf784c57bfed" name="ga24e895a00f9d484db33aaf784c57bfed"></a>
 257 <h2 class="memtitle"><span class="permalink"><a href="#ga24e895a00f9d484db33aaf784c57bfed">&#9670;&#160;</a></span>osMessageQueueNew()</h2>
 258
 259 <div class="memitem">
 260 <div class="memproto">
 261       <table class="memname">
 262         <tr>
 263           <td class="memname"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> osMessageQueueNew </td>
 264           <td>(</td>
 265           <td class="paramtype">uint32_t&#160;</td>
 266           <td class="paramname"><em>msg_count</em>, </td>
 267         </tr>
 268         <tr>
 269           <td class="paramkey"></td>
 270           <td></td>
 271           <td class="paramtype">uint32_t&#160;</td>
 272           <td class="paramname"><em>msg_size</em>, </td>
 273         </tr>
 274         <tr>
 275           <td class="paramkey"></td>
 276           <td></td>
 277           <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">osMessageQueueAttr_t</a> *&#160;</td>
 278           <td class="paramname"><em>attr</em>&#160;</td>
 279         </tr>
 280         <tr>
 281           <td></td>
 282           <td>)</td>
 283           <td></td><td></td>
 284         </tr>
 285       </table>
 286 </div><div class="memdoc">
 287 <dl class="params"><dt>Parameters</dt><dd>
 288   <table class="params">
 289     <tr><td class="paramdir">[in]</td><td class="paramname">msg_count</td><td>maximum number of messages in queue. </td></tr>
 290     <tr><td class="paramdir">[in]</td><td class="paramname">msg_size</td><td>maximum message size in bytes. </td></tr>
 291     <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>message queue attributes; NULL: default values. </td></tr>
 292   </table>
 293   </dd>
 294 </dl>
 295 <dl class="section return"><dt>Returns</dt><dd>message queue ID for reference by other functions or NULL in case of error.</dd></dl>
 296 <p>The function <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> creates and initializes a message queue object. The function returns a message queue object identifier or <span class="XML-Token">NULL</span> in case of an error.</p>
 297 <p>The function can be called after kernel initialization with <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#gae818f6611d25ba3140bede410a52d659">osKernelInitialize</a>. It is possible to create message queue objects before the RTOS kernel is started with <a class="el" href="group__CMSIS__RTOS__KernelCtrl.html#ga9ae2cc00f0d89d7b6a307bba942b5221">osKernelStart</a>.</p>
 298 <p>The total amount of memory required for the message queue data is at least <code>msg_count * msg_size</code>. The <em>msg_size</em> is rounded up to a double even number to ensure 32-bit alignment of the memory blocks.</p>
 299 <p>The memory blocks allocated from the message queue have a fixed size defined with the parameter <code>msg_size</code>.</p>
 300 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from Interrupt Service Routines.</dd></dl>
 301 <p><b>Code Example</b></p>
 302 <p>Refer to <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> </p>
 303
 304 </div>
 305 </div>
 306 <a id="gae7cf7bf2b97a5ae481fb60fcce99247a" name="gae7cf7bf2b97a5ae481fb60fcce99247a"></a>
 307 <h2 class="memtitle"><span class="permalink"><a href="#gae7cf7bf2b97a5ae481fb60fcce99247a">&#9670;&#160;</a></span>osMessageQueueGetName()</h2>
 308
 309 <div class="memitem">
 310 <div class="memproto">
 311       <table class="memname">
 312         <tr>
 313           <td class="memname">const char * osMessageQueueGetName </td>
 314           <td>(</td>
 315           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 316           <td class="paramname"><em>mq_id</em></td><td>)</td>
 317           <td></td>
 318         </tr>
 319       </table>
 320 </div><div class="memdoc">
 321 <dl class="params"><dt>Parameters</dt><dd>
 322   <table class="params">
 323     <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>
 324   </table>
 325   </dd>
 326 </dl>
 327 <dl class="section return"><dt>Returns</dt><dd>name as null-terminated string.</dd></dl>
 328 <p>The function <b>osMessageQueueGetName</b> returns the pointer to the name string of the message queue identified by parameter <em>mq_id</em> or <span class="XML-Token">NULL</span> in case of an error.</p>
 329 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines. </dd></dl>
 330
 331 </div>
 332 </div>
 333 <a id="gaa515fc8b956f721a8f72b2c505813bfc" name="gaa515fc8b956f721a8f72b2c505813bfc"></a>
 334 <h2 class="memtitle"><span class="permalink"><a href="#gaa515fc8b956f721a8f72b2c505813bfc">&#9670;&#160;</a></span>osMessageQueuePut()</h2>
 335
 336 <div class="memitem">
 337 <div class="memproto">
 338       <table class="memname">
 339         <tr>
 340           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueuePut </td>
 341           <td>(</td>
 342           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 343           <td class="paramname"><em>mq_id</em>, </td>
 344         </tr>
 345         <tr>
 346           <td class="paramkey"></td>
 347           <td></td>
 348           <td class="paramtype">const void *&#160;</td>
 349           <td class="paramname"><em>msg_ptr</em>, </td>
 350         </tr>
 351         <tr>
 352           <td class="paramkey"></td>
 353           <td></td>
 354           <td class="paramtype">uint8_t&#160;</td>
 355           <td class="paramname"><em>msg_prio</em>, </td>
 356         </tr>
 357         <tr>
 358           <td class="paramkey"></td>
 359           <td></td>
 360           <td class="paramtype">uint32_t&#160;</td>
 361           <td class="paramname"><em>timeout</em>&#160;</td>
 362         </tr>
 363         <tr>
 364           <td></td>
 365           <td>)</td>
 366           <td></td><td></td>
 367         </tr>
 368       </table>
 369 </div><div class="memdoc">
 370 <dl class="params"><dt>Parameters</dt><dd>
 371   <table class="params">
 372     <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>
 373     <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>
 374     <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr>
 375     <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>CMSIS_RTOS_TimeOutValue or 0 in case of no time-out. </td></tr>
 376   </table>
 377   </dd>
 378 </dl>
 379 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 380 <p>The blocking function <b>osMessageQueuePut</b> puts the message pointed to by <em>msg_ptr</em> into the the message queue specified by parameter <em>mq_id</em>. The parameter <em>msg_prio</em> is used to sort message according their priority (higher numbers indicate a higher priority) on insertion.</p>
 381 <p>The parameter <em>timeout</em> specifies how long the system waits to put the message into the queue. While the system waits, the thread that is calling this function is put into the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">BLOCKED</a> state. The parameter timeout can have the following values:</p><ul>
 382 <li>when <em>timeout</em> is <span class="XML-Token">0</span>, the function returns instantly (i.e. try semantics).</li>
 383 <li>when <em>timeout</em> is set to <b>osWaitForever</b> the function will wait for an infinite time until the message is delivered (i.e. wait semantics).</li>
 384 <li>all other values specify a time in kernel ticks for a timeout (i.e. timed-wait semantics).</li>
 385 </ul>
 386 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 387 <li><em>osOK:</em> the message has been put into the queue.</li>
 388 <li><em>osErrorTimeout:</em> the message could not be put into the queue in the given time (wait-timed semantics).</li>
 389 <li><em>osErrorResource:</em> not enough space in the queue (try semantics).</li>
 390 <li><em>osErrorParameter:</em> parameter <em>mq_id</em> is <span class="XML-Token">NULL</span> or invalid, non-zero timeout specified in an ISR.</li>
 391 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 392 </ul>
 393 <dl class="section note"><dt>Note</dt><dd>May be called from Interrupt Service Routines if the parameter <em>timeout</em> is set to <span class="XML-Token">0</span>.</dd></dl>
 394 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="cmsis__os2_8h.html">cmsis_os2.h</a>&quot;</span>                          <span class="comment">// CMSIS RTOS header file</span></div>
 395 <div class="line"> </div>
 396 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
 397 <div class="line"><span class="comment"> *      Message Queue creation &amp; usage</span></div>
 398 <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
 399 <div class="line"> </div>
 400 <div class="line"><span class="preprocessor">#define MSGQUEUE_OBJECTS 16                     </span><span class="comment">// number of Message Queue Objects</span></div>
 401 <div class="line"> </div>
 402 <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{                                <span class="comment">// object data type</span></div>
 403 <div class="line">  uint8_t Buf[32];</div>
 404 <div class="line">  uint8_t Idx;</div>
 405 <div class="line">} MSGQUEUE_OBJ_t;</div>
 406 <div class="line"> </div>
 407 <div class="line"><a class="code hl_typedef" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mid_MsgQueue;                <span class="comment">// message queue id</span></div>
 408 <div class="line"> </div>
 409 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> tid_Thread_MsgQueue1;              <span class="comment">// thread id 1</span></div>
 410 <div class="line"><a class="code hl_typedef" href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a> tid_Thread_MsgQueue2;              <span class="comment">// thread id 2</span></div>
 411 <div class="line"> </div>
 412 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue1 (<span class="keywordtype">void</span> *argument);         <span class="comment">// thread function 1</span></div>
 413 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue2 (<span class="keywordtype">void</span> *argument);         <span class="comment">// thread function 2</span></div>
 414 <div class="line"> </div>
 415 <div class="line"><span class="keywordtype">int</span> Init_MsgQueue (<span class="keywordtype">void</span>) {</div>
 416 <div class="line"> </div>
 417 <div class="line">  mid_MsgQueue = <a class="code hl_function" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>(MSGQUEUE_OBJECTS, <span class="keyword">sizeof</span>(MSGQUEUE_OBJ_t), NULL);</div>
 418 <div class="line">  <span class="keywordflow">if</span> (mid_MsgQueue == NULL) {</div>
 419 <div class="line">    ; <span class="comment">// Message Queue object not created, handle failure</span></div>
 420 <div class="line">  }</div>
 421 <div class="line"> </div>
 422 <div class="line">  tid_Thread_MsgQueue1 = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>(Thread_MsgQueue1, NULL, NULL);</div>
 423 <div class="line">  <span class="keywordflow">if</span> (tid_Thread_MsgQueue1 == NULL) {</div>
 424 <div class="line">    <span class="keywordflow">return</span>(-1);</div>
 425 <div class="line">  }</div>
 426 <div class="line">  tid_Thread_MsgQueue2 = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a>(Thread_MsgQueue2, NULL, NULL);</div>
 427 <div class="line">  <span class="keywordflow">if</span> (tid_Thread_MsgQueue2 == NULL) {</div>
 428 <div class="line">    <span class="keywordflow">return</span>(-1);</div>
 429 <div class="line">  }</div>
 430 <div class="line"> </div>
 431 <div class="line">  <span class="keywordflow">return</span>(0);</div>
 432 <div class="line">}</div>
 433 <div class="line"> </div>
 434 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue1 (<span class="keywordtype">void</span> *argument) {</div>
 435 <div class="line">  MSGQUEUE_OBJ_t msg;</div>
 436 <div class="line"> </div>
 437 <div class="line">  <span class="keywordflow">while</span> (1) {</div>
 438 <div class="line">    ; <span class="comment">// Insert thread code here...</span></div>
 439 <div class="line">    msg.Buf[0] = 0x55U;                                         <span class="comment">// do some work...</span></div>
 440 <div class="line">    msg.Idx    = 0U;</div>
 441 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a>(mid_MsgQueue, &amp;msg, 0U, 0U);</div>
 442 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#gad01c7ec26535b1de6b018bb9466720e2">osThreadYield</a>();                                            <span class="comment">// suspend thread</span></div>
 443 <div class="line">  }</div>
 444 <div class="line">}</div>
 445 <div class="line"> </div>
 446 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue2 (<span class="keywordtype">void</span> *argument) {</div>
 447 <div class="line">  MSGQUEUE_OBJ_t msg;</div>
 448 <div class="line">  <a class="code hl_enumeration" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> status;</div>
 449 <div class="line"> </div>
 450 <div class="line">  <span class="keywordflow">while</span> (1) {</div>
 451 <div class="line">    ; <span class="comment">// Insert thread code here...</span></div>
 452 <div class="line">    status = <a class="code hl_function" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a>(mid_MsgQueue, &amp;msg, NULL, 0U);   <span class="comment">// wait for message</span></div>
 453 <div class="line">    <span class="keywordflow">if</span> (status == <a class="code hl_enumvalue" href="cmsis__os2_8h.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea9e1c9e2550bb4de8969a935acffc968f">osOK</a>) {</div>
 454 <div class="line">      ; <span class="comment">// process data</span></div>
 455 <div class="line">    }</div>
 456 <div class="line">  }</div>
 457 <div class="line">}</div>
 458 <div class="ttc" id="acmsis__os2_8h_html"><div class="ttname"><a href="cmsis__os2_8h.html">cmsis_os2.h</a></div></div>
 459 <div class="ttc" id="acmsis__os2_8h_html_a206dbc05367e03c39fc6d4d1ebcff317"><div class="ttname"><a href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a></div><div class="ttdeci">void * osMessageQueueId_t</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:278</div></div>
 460 <div class="ttc" id="acmsis__os2_8h_html_ga6c0dbe6069e4e7f47bb4cd32ae2b813ea9e1c9e2550bb4de8969a935acffc968f"><div class="ttname"><a href="cmsis__os2_8h.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813ea9e1c9e2550bb4de8969a935acffc968f">osOK</a></div><div class="ttdeci">@ osOK</div><div class="ttdoc">Operation completed successfully.</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:247</div></div>
 461 <div class="ttc" id="agroup__CMSIS__RTOS__Definitions_html_ga6c0dbe6069e4e7f47bb4cd32ae2b813e"><div class="ttname"><a href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a></div><div class="ttdeci">osStatus_t</div><div class="ttdoc">Status code values returned by CMSIS-RTOS functions.</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:246</div></div>
 462 <div class="ttc" id="agroup__CMSIS__RTOS__Message_html_ga24e895a00f9d484db33aaf784c57bfed"><div class="ttname"><a href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a></div><div class="ttdeci">osMessageQueueId_t osMessageQueueNew(uint32_t msg_count, uint32_t msg_size, const osMessageQueueAttr_t *attr)</div><div class="ttdoc">Create and Initialize a Message Queue object.</div></div>
 463 <div class="ttc" id="agroup__CMSIS__RTOS__Message_html_gaa515fc8b956f721a8f72b2c505813bfc"><div class="ttname"><a href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a></div><div class="ttdeci">osStatus_t osMessageQueuePut(osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t timeout)</div><div class="ttdoc">Put a Message into a Queue or timeout if Queue is full.</div></div>
 464 <div class="ttc" id="agroup__CMSIS__RTOS__Message_html_gad90d4959466a7a65105061da8256ab9e"><div class="ttname"><a href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a></div><div class="ttdeci">osStatus_t osMessageQueueGet(osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t timeout)</div><div class="ttdoc">Get a Message from a Queue or timeout if Queue is empty.</div></div>
 465 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadMgmt_html_ga48d68b8666d99d28fa646ee1d2182b8f"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f">osThreadNew</a></div><div class="ttdeci">osThreadId_t osThreadNew(osThreadFunc_t func, void *argument, const osThreadAttr_t *attr)</div><div class="ttdoc">Create a thread and add it to Active Threads.</div></div>
 466 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadMgmt_html_gaa6c32fe2a3e0a2e01f212d55b02e51c7"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadMgmt.html#gaa6c32fe2a3e0a2e01f212d55b02e51c7">osThreadId_t</a></div><div class="ttdeci">void * osThreadId_t</div><div class="ttdef"><b>Definition:</b> cmsis_os2.h:260</div></div>
 467 <div class="ttc" id="agroup__CMSIS__RTOS__ThreadMgmt_html_gad01c7ec26535b1de6b018bb9466720e2"><div class="ttname"><a href="group__CMSIS__RTOS__ThreadMgmt.html#gad01c7ec26535b1de6b018bb9466720e2">osThreadYield</a></div><div class="ttdeci">osStatus_t osThreadYield(void)</div><div class="ttdoc">Pass control to next thread that is in state READY.</div></div>
 468 </div><!-- fragment -->
 469 </div>
 470 </div>
 471 <a id="gad90d4959466a7a65105061da8256ab9e" name="gad90d4959466a7a65105061da8256ab9e"></a>
 472 <h2 class="memtitle"><span class="permalink"><a href="#gad90d4959466a7a65105061da8256ab9e">&#9670;&#160;</a></span>osMessageQueueGet()</h2>
 473
 474 <div class="memitem">
 475 <div class="memproto">
 476       <table class="memname">
 477         <tr>
 478           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueueGet </td>
 479           <td>(</td>
 480           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 481           <td class="paramname"><em>mq_id</em>, </td>
 482         </tr>
 483         <tr>
 484           <td class="paramkey"></td>
 485           <td></td>
 486           <td class="paramtype">void *&#160;</td>
 487           <td class="paramname"><em>msg_ptr</em>, </td>
 488         </tr>
 489         <tr>
 490           <td class="paramkey"></td>
 491           <td></td>
 492           <td class="paramtype">uint8_t *&#160;</td>
 493           <td class="paramname"><em>msg_prio</em>, </td>
 494         </tr>
 495         <tr>
 496           <td class="paramkey"></td>
 497           <td></td>
 498           <td class="paramtype">uint32_t&#160;</td>
 499           <td class="paramname"><em>timeout</em>&#160;</td>
 500         </tr>
 501         <tr>
 502           <td></td>
 503           <td>)</td>
 504           <td></td><td></td>
 505         </tr>
 506       </table>
 507 </div><div class="memdoc">
 508 <dl class="params"><dt>Parameters</dt><dd>
 509   <table class="params">
 510     <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>
 511     <tr><td class="paramdir">[out]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue. </td></tr>
 512     <tr><td class="paramdir">[out]</td><td class="paramname">msg_prio</td><td>pointer to buffer for message priority or NULL. </td></tr>
 513     <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>CMSIS_RTOS_TimeOutValue or 0 in case of no time-out. </td></tr>
 514   </table>
 515   </dd>
 516 </dl>
 517 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 518 <p>The function <b>osMessageQueueGet</b> retrieves a message from the message queue specified by the parameter <em>mq_id</em> and saves it to the buffer pointed to by the parameter <em>msg_ptr</em>. The message priority is stored to parameter <em>msg_prio</em> if not token{NULL}.</p>
 519 <p>The parameter <em>timeout</em> specifies how long the system waits to retrieve the message from the queue. While the system waits, the thread that is calling this function is put into the <a class="el" href="group__CMSIS__RTOS__ThreadMgmt.html#ThreadStates">BLOCKED</a> state. The parameter timeout can have the following values:</p><ul>
 520 <li>when <em>timeout</em> is <span class="XML-Token">0</span>, the function returns instantly (i.e. try semantics).</li>
 521 <li>when <em>timeout</em> is set to <b>osWaitForever</b> the function will wait for an infinite time until the message is retrieved (i.e. wait semantics).</li>
 522 <li>all other values specify a time in kernel ticks for a timeout (i.e. timed-wait semantics).</li>
 523 </ul>
 524 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 525 <li><em>osOK:</em> the message has been retrieved from the queue.</li>
 526 <li><em>osErrorTimeout:</em> the message could not be retrieved from the queue in the given time (timed-wait semantics).</li>
 527 <li><em>osErrorResource:</em> nothing to get from the queue (try semantics).</li>
 528 <li><em>osErrorParameter:</em> parameter <em>mq_id</em> is <span class="XML-Token">NULL</span> or invalid, non-zero timeout specified in an ISR.</li>
 529 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 530 </ul>
 531 <dl class="section note"><dt>Note</dt><dd>May be called from Interrupt Service Routines if the parameter <em>timeout</em> is set to <span class="XML-Token">0</span>.</dd></dl>
 532 <p><b>Code Example</b></p>
 533 <p>Refer to <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> </p>
 534
 535 </div>
 536 </div>
 537 <a id="gac24f87d4f395e9e9c900c320e45ade8a" name="gac24f87d4f395e9e9c900c320e45ade8a"></a>
 538 <h2 class="memtitle"><span class="permalink"><a href="#gac24f87d4f395e9e9c900c320e45ade8a">&#9670;&#160;</a></span>osMessageQueueGetCapacity()</h2>
 539
 540 <div class="memitem">
 541 <div class="memproto">
 542       <table class="memname">
 543         <tr>
 544           <td class="memname">uint32_t osMessageQueueGetCapacity </td>
 545           <td>(</td>
 546           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 547           <td class="paramname"><em>mq_id</em></td><td>)</td>
 548           <td></td>
 549         </tr>
 550       </table>
 551 </div><div class="memdoc">
 552 <dl class="params"><dt>Parameters</dt><dd>
 553   <table class="params">
 554     <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>
 555   </table>
 556   </dd>
 557 </dl>
 558 <dl class="section return"><dt>Returns</dt><dd>maximum number of messages.</dd></dl>
 559 <p>The function <b>osMessageQueueGetCapacity</b> returns the maximum number of messages in the message queue object specified by parameter <em>mq_id</em> or <span class="XML-Token">0</span> in case of an error.</p>
 560 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines. </dd></dl>
 561
 562 </div>
 563 </div>
 564 <a id="ga96d3d84069b20359de48109e28a1a89e" name="ga96d3d84069b20359de48109e28a1a89e"></a>
 565 <h2 class="memtitle"><span class="permalink"><a href="#ga96d3d84069b20359de48109e28a1a89e">&#9670;&#160;</a></span>osMessageQueueGetMsgSize()</h2>
 566
 567 <div class="memitem">
 568 <div class="memproto">
 569       <table class="memname">
 570         <tr>
 571           <td class="memname">uint32_t osMessageQueueGetMsgSize </td>
 572           <td>(</td>
 573           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 574           <td class="paramname"><em>mq_id</em></td><td>)</td>
 575           <td></td>
 576         </tr>
 577       </table>
 578 </div><div class="memdoc">
 579 <dl class="params"><dt>Parameters</dt><dd>
 580   <table class="params">
 581     <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>
 582   </table>
 583   </dd>
 584 </dl>
 585 <dl class="section return"><dt>Returns</dt><dd>maximum message size in bytes.</dd></dl>
 586 <p>The function <b>osMessageQueueGetMsgSize</b> returns the maximum message size in bytes for the message queue object specified by parameter <em>mq_id</em> or <span class="XML-Token">0</span> in case of an error.</p>
 587 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines. </dd></dl>
 588
 589 </div>
 590 </div>
 591 <a id="ga6a32ac394fcff568b251c160cc3014b2" name="ga6a32ac394fcff568b251c160cc3014b2"></a>
 592 <h2 class="memtitle"><span class="permalink"><a href="#ga6a32ac394fcff568b251c160cc3014b2">&#9670;&#160;</a></span>osMessageQueueGetCount()</h2>
 593
 594 <div class="memitem">
 595 <div class="memproto">
 596       <table class="memname">
 597         <tr>
 598           <td class="memname">uint32_t osMessageQueueGetCount </td>
 599           <td>(</td>
 600           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 601           <td class="paramname"><em>mq_id</em></td><td>)</td>
 602           <td></td>
 603         </tr>
 604       </table>
 605 </div><div class="memdoc">
 606 <dl class="params"><dt>Parameters</dt><dd>
 607   <table class="params">
 608     <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>
 609   </table>
 610   </dd>
 611 </dl>
 612 <dl class="section return"><dt>Returns</dt><dd>number of queued messages.</dd></dl>
 613 <p>The function <b>osMessageQueueGetCount</b> returns the number of queued messages in the message queue object specified by parameter <em>mq_id</em> or <span class="XML-Token">0</span> in case of an error.</p>
 614 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines. </dd></dl>
 615
 616 </div>
 617 </div>
 618 <a id="gaddf0904427436dd3880d46263c2dc9fa" name="gaddf0904427436dd3880d46263c2dc9fa"></a>
 619 <h2 class="memtitle"><span class="permalink"><a href="#gaddf0904427436dd3880d46263c2dc9fa">&#9670;&#160;</a></span>osMessageQueueGetSpace()</h2>
 620
 621 <div class="memitem">
 622 <div class="memproto">
 623       <table class="memname">
 624         <tr>
 625           <td class="memname">uint32_t osMessageQueueGetSpace </td>
 626           <td>(</td>
 627           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 628           <td class="paramname"><em>mq_id</em></td><td>)</td>
 629           <td></td>
 630         </tr>
 631       </table>
 632 </div><div class="memdoc">
 633 <dl class="params"><dt>Parameters</dt><dd>
 634   <table class="params">
 635     <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>
 636   </table>
 637   </dd>
 638 </dl>
 639 <dl class="section return"><dt>Returns</dt><dd>number of available slots for messages.</dd></dl>
 640 <p>The function <b>osMessageQueueGetSpace</b> returns the number available slots for messages in the message queue object specified by parameter <em>mq_id</em> or <span class="XML-Token">0</span> in case of an error.</p>
 641 <dl class="section note"><dt>Note</dt><dd>This function may be called from Interrupt Service Routines. </dd></dl>
 642
 643 </div>
 644 </div>
 645 <a id="gac6dce7f9ad132d266292c2e979d861b4" name="gac6dce7f9ad132d266292c2e979d861b4"></a>
 646 <h2 class="memtitle"><span class="permalink"><a href="#gac6dce7f9ad132d266292c2e979d861b4">&#9670;&#160;</a></span>osMessageQueueReset()</h2>
 647
 648 <div class="memitem">
 649 <div class="memproto">
 650       <table class="memname">
 651         <tr>
 652           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueueReset </td>
 653           <td>(</td>
 654           <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a>&#160;</td>
 655           <td class="paramname"><em>mq_id</em></td><td>)</td>
 656           <td></td>
 657         </tr>
 658       </table>
 659 </div><div class="memdoc">
 660 <dl class="params"><dt>Parameters</dt><dd>
 661   <table class="params">
 662     <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>
 663   </table>
 664   </dd>
 665 </dl>
 666 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 667 <p>The function <b>osMessageQueueReset</b> resets the message queue specified by the parameter <em>mq_id</em>.</p>
 668 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 669 <li><em>osOK:</em> the message queue has been rest.</li>
 670 <li><em>osErrorParameter:</em> parameter <em>mq_id</em> is <span class="XML-Token">NULL</span> or invalid.</li>
 671 <li><em>osErrorResource:</em> the message queue is in an invalid state.</li>
 672 <li><em>osErrorISR:</em> <b>osMessageQueueReset</b> cannot be called from interrupt service routines.</li>
 673 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 674 </ul>
 675 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from Interrupt Service Routines. </dd></dl>
 676
 677 </div>
 678 </div>
 679 <a id="gaba987f665444e0d83fa6a3a68bc72abe" name="gaba987f665444e0d83fa6a3a68bc72abe"></a>
 680 <h2 class="memtitle"><span class="permalink"><a href="#gaba987f665444e0d83fa6a3a68bc72abe">&#9670;&#160;</a></span>osMessageQueueDelete()</h2>
 681
 682 <div class="memitem">
 683 <div class="memproto">
 684       <table class="memname">
 685         <tr>
 686           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueueDelete </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><td>)</td>
 690           <td></td>
 691         </tr>
 692       </table>
 693 </div><div class="memdoc">
 694 <dl class="params"><dt>Parameters</dt><dd>
 695   <table class="params">
 696     <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>
 697   </table>
 698   </dd>
 699 </dl>
 700 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 701 <p>The function <b>osMessageQueueDelete</b> deletes a message queue object specified by parameter <em>mq_id</em>. It releases internal memory obtained for message queue handling. After this call, the <em>mq_id</em> is no longer valid and cannot be used. The message queue may be created again using the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</p>
 702 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 703 <li><em>osOK:</em> the message queue object has been deleted.</li>
 704 <li><em>osErrorParameter:</em> parameter <em>mq_id</em> is <span class="XML-Token">NULL</span> or invalid.</li>
 705 <li><em>osErrorResource:</em> the message queue is in an invalid state.</li>
 706 <li><em>osErrorISR:</em> <b>osMessageQueueDelete</b> cannot be called from interrupt service routines.</li>
 707 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 708 </ul>
 709 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from Interrupt Service Routines. </dd></dl>
 710
 711 </div>
 712 </div>
 713 </div><!-- contents -->
 714 </div><!-- doc-content -->
 715 <!-- start footer part -->
 716 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 717   <ul>
 718     <li class="footer">
 719       <script type="text/javascript">
 720         <!--
 721         writeFooter.call(this);
 722         //-->
 723       </script>
 724     </li>
 725   </ul>
 726 </div>
 727 </body>
 728 </html>