begriffs open source - cmsis/blob - main/RTOS2/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);
  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-RTOS2 API</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">osMessageQueueId_t&#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> (osMessageQueueId_t 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> (osMessageQueueId_t 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> (osMessageQueueId_t 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> (osMessageQueueId_t 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> (osMessageQueueId_t 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> (osMessageQueueId_t 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> (osMessageQueueId_t 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> (osMessageQueueId_t 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> (osMessageQueueId_t 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>Exchange messages between threads in a FIFO-like operation. </p>
 181 <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>
 182 <div class="image">
 183 <img src="MessageQueue.png" alt=""/>
 184 <div class="caption">
 185 CMSIS-RTOS Message Queue</div></div>
 186 <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>
 187 <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 <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 188 <hr/><h2 class="groupheader">Data Structure Documentation</h2>
 189 <a name="structosMessageQueueAttr__t" id="structosMessageQueueAttr__t"></a>
 190 <h2 class="memtitle"><span class="permalink"><a href="#structosMessageQueueAttr__t">&#9670;&#160;</a></span>osMessageQueueAttr_t</h2>
 191
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">struct osMessageQueueAttr_t</td>
 197         </tr>
 198       </table>
 199 </div><div class="memdoc">
 200 <div class="textblock"><p>Attributes structure for message queue. </p>
 201 <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 <a class="el" href="usingOS2.html#CMSIS_RTOS_MemoryMgmt_Manual">Manual User-defined Allocation</a> for more information.</p>
 225 <p>Default: <span class="XML-Token">NULL</span> to use <a class="el" href="usingOS2.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>. Required value depends on the underlying kernel implementation.</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 <a class="el" href="usingOS2.html#CMSIS_RTOS_MemoryMgmt_Manual">Manual User-defined Allocation</a> for more information.</p>
 241 <p>Default: <span class="XML-Token">NULL</span> to use <a class="el" href="usingOS2.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">osMessageQueueId_t 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
 288 <p>Create and Initialize a Message Queue object. </p>
 289 <dl class="params"><dt>Parameters</dt><dd>
 290   <table class="params">
 291     <tr><td class="paramdir">[in]</td><td class="paramname">msg_count</td><td>maximum number of messages in queue. </td></tr>
 292     <tr><td class="paramdir">[in]</td><td class="paramname">msg_size</td><td>maximum message size in bytes. </td></tr>
 293     <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>message queue attributes; NULL: default values. </td></tr>
 294   </table>
 295   </dd>
 296 </dl>
 297 <dl class="section return"><dt>Returns</dt><dd>message queue ID for reference by other functions or NULL in case of error.</dd></dl>
 298 <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>
 299 <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>
 300 <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>
 301 <p>The memory blocks allocated from the message queue have a fixed size defined with the parameter <code>msg_size</code>.</p>
 302 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>.</dd></dl>
 303 <p><b>Code Example</b></p>
 304 <p>Refer to <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> </p>
 305
 306 </div>
 307 </div>
 308 <a id="gae7cf7bf2b97a5ae481fb60fcce99247a" name="gae7cf7bf2b97a5ae481fb60fcce99247a"></a>
 309 <h2 class="memtitle"><span class="permalink"><a href="#gae7cf7bf2b97a5ae481fb60fcce99247a">&#9670;&#160;</a></span>osMessageQueueGetName()</h2>
 310
 311 <div class="memitem">
 312 <div class="memproto">
 313       <table class="memname">
 314         <tr>
 315           <td class="memname">const char * osMessageQueueGetName </td>
 316           <td>(</td>
 317           <td class="paramtype">osMessageQueueId_t&#160;</td>
 318           <td class="paramname"><em>mq_id</em></td><td>)</td>
 319           <td></td>
 320         </tr>
 321       </table>
 322 </div><div class="memdoc">
 323
 324 <p>Get name of a Message Queue object. </p>
 325 <dl class="params"><dt>Parameters</dt><dd>
 326   <table class="params">
 327     <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>
 328   </table>
 329   </dd>
 330 </dl>
 331 <dl class="section return"><dt>Returns</dt><dd>name as null-terminated string.</dd></dl>
 332 <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>
 333 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 334
 335 </div>
 336 </div>
 337 <a id="gaa515fc8b956f721a8f72b2c505813bfc" name="gaa515fc8b956f721a8f72b2c505813bfc"></a>
 338 <h2 class="memtitle"><span class="permalink"><a href="#gaa515fc8b956f721a8f72b2c505813bfc">&#9670;&#160;</a></span>osMessageQueuePut()</h2>
 339
 340 <div class="memitem">
 341 <div class="memproto">
 342       <table class="memname">
 343         <tr>
 344           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueuePut </td>
 345           <td>(</td>
 346           <td class="paramtype">osMessageQueueId_t&#160;</td>
 347           <td class="paramname"><em>mq_id</em>, </td>
 348         </tr>
 349         <tr>
 350           <td class="paramkey"></td>
 351           <td></td>
 352           <td class="paramtype">const void *&#160;</td>
 353           <td class="paramname"><em>msg_ptr</em>, </td>
 354         </tr>
 355         <tr>
 356           <td class="paramkey"></td>
 357           <td></td>
 358           <td class="paramtype">uint8_t&#160;</td>
 359           <td class="paramname"><em>msg_prio</em>, </td>
 360         </tr>
 361         <tr>
 362           <td class="paramkey"></td>
 363           <td></td>
 364           <td class="paramtype">uint32_t&#160;</td>
 365           <td class="paramname"><em>timeout</em>&#160;</td>
 366         </tr>
 367         <tr>
 368           <td></td>
 369           <td>)</td>
 370           <td></td><td></td>
 371         </tr>
 372       </table>
 373 </div><div class="memdoc">
 374
 375 <p>Put a Message into a Queue or timeout if Queue is full. </p>
 376 <dl class="params"><dt>Parameters</dt><dd>
 377   <table class="params">
 378     <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>
 379     <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>
 380     <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr>
 381     <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="usingOS2.html#CMSIS_RTOS_TimeOutValue">Timeout Values</a> or 0 in case of no time-out. </td></tr>
 382   </table>
 383   </dd>
 384 </dl>
 385 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 386 <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>
 387 <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 <a class="el" href="usingOS2.html#CMSIS_RTOS_TimeOutValue">timeout</a> can have the following values:</p><ul>
 388 <li>when <em>timeout</em> is <span class="XML-Token">0</span>, the function returns instantly (i.e. try semantics).</li>
 389 <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>
 390 <li>all other values specify a time in kernel ticks for a timeout (i.e. timed-wait semantics).</li>
 391 </ul>
 392 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 393 <li><em>osOK:</em> the message has been put into the queue.</li>
 394 <li><em>osErrorTimeout:</em> the message could not be put into the queue in the given time (wait-timed semantics).</li>
 395 <li><em>osErrorResource:</em> not enough space in the queue (try semantics).</li>
 396 <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>
 397 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 398 </ul>
 399 <dl class="section note"><dt>Note</dt><dd>May be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a> if the parameter <em>timeout</em> is set to <span class="XML-Token">0</span>.</dd></dl>
 400 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;cmsis_os2.h&quot;</span>                          <span class="comment">// CMSIS RTOS header file</span></div>
 401 <div class="line"> </div>
 402 <div class="line"><span class="comment">/*----------------------------------------------------------------------------</span></div>
 403 <div class="line"><span class="comment"> *      Message Queue creation &amp; usage</span></div>
 404 <div class="line"><span class="comment"> *---------------------------------------------------------------------------*/</span></div>
 405 <div class="line"> </div>
 406 <div class="line"><span class="preprocessor">#define MSGQUEUE_OBJECTS 16                     </span><span class="comment">// number of Message Queue Objects</span></div>
 407 <div class="line"> </div>
 408 <div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{                                <span class="comment">// object data type</span></div>
 409 <div class="line">  uint8_t Buf[32];</div>
 410 <div class="line">  uint8_t Idx;</div>
 411 <div class="line">} MSGQUEUE_OBJ_t;</div>
 412 <div class="line"> </div>
 413 <div class="line">osMessageQueueId_t mid_MsgQueue;                <span class="comment">// message queue id</span></div>
 414 <div class="line"> </div>
 415 <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>
 416 <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>
 417 <div class="line"> </div>
 418 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue1 (<span class="keywordtype">void</span> *argument);         <span class="comment">// thread function 1</span></div>
 419 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue2 (<span class="keywordtype">void</span> *argument);         <span class="comment">// thread function 2</span></div>
 420 <div class="line"> </div>
 421 <div class="line"><span class="keywordtype">int</span> Init_MsgQueue (<span class="keywordtype">void</span>) {</div>
 422 <div class="line"> </div>
 423 <div class="line">  mid_MsgQueue = <a class="code hl_function" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed" title="Create and Initialize a Message Queue object.">osMessageQueueNew</a>(MSGQUEUE_OBJECTS, <span class="keyword">sizeof</span>(MSGQUEUE_OBJ_t), NULL);</div>
 424 <div class="line">  <span class="keywordflow">if</span> (mid_MsgQueue == NULL) {</div>
 425 <div class="line">    ; <span class="comment">// Message Queue object not created, handle failure</span></div>
 426 <div class="line">  }</div>
 427 <div class="line"> </div>
 428 <div class="line">  tid_Thread_MsgQueue1 = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f" title="Create a thread and add it to Active Threads.">osThreadNew</a>(Thread_MsgQueue1, NULL, NULL);</div>
 429 <div class="line">  <span class="keywordflow">if</span> (tid_Thread_MsgQueue1 == NULL) {</div>
 430 <div class="line">    <span class="keywordflow">return</span>(-1);</div>
 431 <div class="line">  }</div>
 432 <div class="line">  tid_Thread_MsgQueue2 = <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#ga48d68b8666d99d28fa646ee1d2182b8f" title="Create a thread and add it to Active Threads.">osThreadNew</a>(Thread_MsgQueue2, NULL, NULL);</div>
 433 <div class="line">  <span class="keywordflow">if</span> (tid_Thread_MsgQueue2 == NULL) {</div>
 434 <div class="line">    <span class="keywordflow">return</span>(-1);</div>
 435 <div class="line">  }</div>
 436 <div class="line"> </div>
 437 <div class="line">  <span class="keywordflow">return</span>(0);</div>
 438 <div class="line">}</div>
 439 <div class="line"> </div>
 440 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue1 (<span class="keywordtype">void</span> *argument) {</div>
 441 <div class="line">  MSGQUEUE_OBJ_t msg;</div>
 442 <div class="line"> </div>
 443 <div class="line">  <span class="keywordflow">while</span> (1) {</div>
 444 <div class="line">    ; <span class="comment">// Insert thread code here...</span></div>
 445 <div class="line">    msg.Buf[0] = 0x55U;                                         <span class="comment">// do some work...</span></div>
 446 <div class="line">    msg.Idx    = 0U;</div>
 447 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc" title="Put a Message into a Queue or timeout if Queue is full.">osMessageQueuePut</a>(mid_MsgQueue, &amp;msg, 0U, 0U);</div>
 448 <div class="line">    <a class="code hl_function" href="group__CMSIS__RTOS__ThreadMgmt.html#gad01c7ec26535b1de6b018bb9466720e2" title="Pass control to next thread that is in state READY.">osThreadYield</a>();                                            <span class="comment">// suspend thread</span></div>
 449 <div class="line">  }</div>
 450 <div class="line">}</div>
 451 <div class="line"> </div>
 452 <div class="line"><span class="keywordtype">void</span> Thread_MsgQueue2 (<span class="keywordtype">void</span> *argument) {</div>
 453 <div class="line">  MSGQUEUE_OBJ_t msg;</div>
 454 <div class="line">  <a class="code hl_enumeration" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e" title="Status code values returned by CMSIS-RTOS functions.">osStatus_t</a> status;</div>
 455 <div class="line"> </div>
 456 <div class="line">  <span class="keywordflow">while</span> (1) {</div>
 457 <div class="line">    ; <span class="comment">// Insert thread code here...</span></div>
 458 <div class="line">    status = <a class="code hl_function" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e" title="Get a Message from a Queue or timeout if Queue is empty.">osMessageQueueGet</a>(mid_MsgQueue, &amp;msg, NULL, 0U);   <span class="comment">// wait for message</span></div>
 459 <div class="line">    <span class="keywordflow">if</span> (status == <a class="code hl_enumvalue" href="group__CMSIS__RTOS__Definitions.html#gga6c0dbe6069e4e7f47bb4cd32ae2b813eab17c65ad8b5bae759882b41c5bf35cda" title="Operation completed successfully.">osOK</a>) {</div>
 460 <div class="line">      ; <span class="comment">// process data</span></div>
 461 <div class="line">    }</div>
 462 <div class="line">  }</div>
 463 <div class="line">}</div>
 464 </div><!-- fragment -->
 465 </div>
 466 </div>
 467 <a id="gad90d4959466a7a65105061da8256ab9e" name="gad90d4959466a7a65105061da8256ab9e"></a>
 468 <h2 class="memtitle"><span class="permalink"><a href="#gad90d4959466a7a65105061da8256ab9e">&#9670;&#160;</a></span>osMessageQueueGet()</h2>
 469
 470 <div class="memitem">
 471 <div class="memproto">
 472       <table class="memname">
 473         <tr>
 474           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueueGet </td>
 475           <td>(</td>
 476           <td class="paramtype">osMessageQueueId_t&#160;</td>
 477           <td class="paramname"><em>mq_id</em>, </td>
 478         </tr>
 479         <tr>
 480           <td class="paramkey"></td>
 481           <td></td>
 482           <td class="paramtype">void *&#160;</td>
 483           <td class="paramname"><em>msg_ptr</em>, </td>
 484         </tr>
 485         <tr>
 486           <td class="paramkey"></td>
 487           <td></td>
 488           <td class="paramtype">uint8_t *&#160;</td>
 489           <td class="paramname"><em>msg_prio</em>, </td>
 490         </tr>
 491         <tr>
 492           <td class="paramkey"></td>
 493           <td></td>
 494           <td class="paramtype">uint32_t&#160;</td>
 495           <td class="paramname"><em>timeout</em>&#160;</td>
 496         </tr>
 497         <tr>
 498           <td></td>
 499           <td>)</td>
 500           <td></td><td></td>
 501         </tr>
 502       </table>
 503 </div><div class="memdoc">
 504
 505 <p>Get a Message from a Queue or timeout if Queue is empty. </p>
 506 <dl class="params"><dt>Parameters</dt><dd>
 507   <table class="params">
 508     <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>
 509     <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>
 510     <tr><td class="paramdir">[out]</td><td class="paramname">msg_prio</td><td>pointer to buffer for message priority or NULL. </td></tr>
 511     <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="usingOS2.html#CMSIS_RTOS_TimeOutValue">Timeout Values</a> or 0 in case of no time-out. </td></tr>
 512   </table>
 513   </dd>
 514 </dl>
 515 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 516 <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>
 517 <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 <a class="el" href="usingOS2.html#CMSIS_RTOS_TimeOutValue">timeout</a> can have the following values:</p><ul>
 518 <li>when <em>timeout</em> is <span class="XML-Token">0</span>, the function returns instantly (i.e. try semantics).</li>
 519 <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>
 520 <li>all other values specify a time in kernel ticks for a timeout (i.e. timed-wait semantics).</li>
 521 </ul>
 522 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 523 <li><em>osOK:</em> the message has been retrieved from the queue.</li>
 524 <li><em>osErrorTimeout:</em> the message could not be retrieved from the queue in the given time (timed-wait semantics).</li>
 525 <li><em>osErrorResource:</em> nothing to get from the queue (try semantics).</li>
 526 <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>
 527 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 528 </ul>
 529 <dl class="section note"><dt>Note</dt><dd>May be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a> if the parameter <em>timeout</em> is set to <span class="XML-Token">0</span>.</dd></dl>
 530 <p><b>Code Example</b></p>
 531 <p>Refer to <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> </p>
 532
 533 </div>
 534 </div>
 535 <a id="gac24f87d4f395e9e9c900c320e45ade8a" name="gac24f87d4f395e9e9c900c320e45ade8a"></a>
 536 <h2 class="memtitle"><span class="permalink"><a href="#gac24f87d4f395e9e9c900c320e45ade8a">&#9670;&#160;</a></span>osMessageQueueGetCapacity()</h2>
 537
 538 <div class="memitem">
 539 <div class="memproto">
 540       <table class="memname">
 541         <tr>
 542           <td class="memname">uint32_t osMessageQueueGetCapacity </td>
 543           <td>(</td>
 544           <td class="paramtype">osMessageQueueId_t&#160;</td>
 545           <td class="paramname"><em>mq_id</em></td><td>)</td>
 546           <td></td>
 547         </tr>
 548       </table>
 549 </div><div class="memdoc">
 550
 551 <p>Get maximum number of messages in a Message Queue. </p>
 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 <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </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">osMessageQueueId_t&#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
 580 <p>Get maximum message size in a Message Queue. </p>
 581 <dl class="params"><dt>Parameters</dt><dd>
 582   <table class="params">
 583     <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>
 584   </table>
 585   </dd>
 586 </dl>
 587 <dl class="section return"><dt>Returns</dt><dd>maximum message size in bytes.</dd></dl>
 588 <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>
 589 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 590
 591 </div>
 592 </div>
 593 <a id="ga6a32ac394fcff568b251c160cc3014b2" name="ga6a32ac394fcff568b251c160cc3014b2"></a>
 594 <h2 class="memtitle"><span class="permalink"><a href="#ga6a32ac394fcff568b251c160cc3014b2">&#9670;&#160;</a></span>osMessageQueueGetCount()</h2>
 595
 596 <div class="memitem">
 597 <div class="memproto">
 598       <table class="memname">
 599         <tr>
 600           <td class="memname">uint32_t osMessageQueueGetCount </td>
 601           <td>(</td>
 602           <td class="paramtype">osMessageQueueId_t&#160;</td>
 603           <td class="paramname"><em>mq_id</em></td><td>)</td>
 604           <td></td>
 605         </tr>
 606       </table>
 607 </div><div class="memdoc">
 608
 609 <p>Get number of queued messages in a Message Queue. </p>
 610 <dl class="params"><dt>Parameters</dt><dd>
 611   <table class="params">
 612     <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>
 613   </table>
 614   </dd>
 615 </dl>
 616 <dl class="section return"><dt>Returns</dt><dd>number of queued messages.</dd></dl>
 617 <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>
 618 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 619
 620 </div>
 621 </div>
 622 <a id="gaddf0904427436dd3880d46263c2dc9fa" name="gaddf0904427436dd3880d46263c2dc9fa"></a>
 623 <h2 class="memtitle"><span class="permalink"><a href="#gaddf0904427436dd3880d46263c2dc9fa">&#9670;&#160;</a></span>osMessageQueueGetSpace()</h2>
 624
 625 <div class="memitem">
 626 <div class="memproto">
 627       <table class="memname">
 628         <tr>
 629           <td class="memname">uint32_t osMessageQueueGetSpace </td>
 630           <td>(</td>
 631           <td class="paramtype">osMessageQueueId_t&#160;</td>
 632           <td class="paramname"><em>mq_id</em></td><td>)</td>
 633           <td></td>
 634         </tr>
 635       </table>
 636 </div><div class="memdoc">
 637
 638 <p>Get number of available slots for messages in a Message Queue. </p>
 639 <dl class="params"><dt>Parameters</dt><dd>
 640   <table class="params">
 641     <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>
 642   </table>
 643   </dd>
 644 </dl>
 645 <dl class="section return"><dt>Returns</dt><dd>number of available slots for messages.</dd></dl>
 646 <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>
 647 <dl class="section note"><dt>Note</dt><dd>This function may be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 648
 649 </div>
 650 </div>
 651 <a id="gac6dce7f9ad132d266292c2e979d861b4" name="gac6dce7f9ad132d266292c2e979d861b4"></a>
 652 <h2 class="memtitle"><span class="permalink"><a href="#gac6dce7f9ad132d266292c2e979d861b4">&#9670;&#160;</a></span>osMessageQueueReset()</h2>
 653
 654 <div class="memitem">
 655 <div class="memproto">
 656       <table class="memname">
 657         <tr>
 658           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueueReset </td>
 659           <td>(</td>
 660           <td class="paramtype">osMessageQueueId_t&#160;</td>
 661           <td class="paramname"><em>mq_id</em></td><td>)</td>
 662           <td></td>
 663         </tr>
 664       </table>
 665 </div><div class="memdoc">
 666
 667 <p>Reset a Message Queue to initial empty state. </p>
 668 <dl class="params"><dt>Parameters</dt><dd>
 669   <table class="params">
 670     <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>
 671   </table>
 672   </dd>
 673 </dl>
 674 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 675 <p>The function <b>osMessageQueueReset</b> resets the message queue specified by the parameter <em>mq_id</em>.</p>
 676 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 677 <li><em>osOK:</em> the message queue has been rest.</li>
 678 <li><em>osErrorParameter:</em> parameter <em>mq_id</em> is <span class="XML-Token">NULL</span> or invalid.</li>
 679 <li><em>osErrorResource:</em> the message queue is in an invalid state.</li>
 680 <li><em>osErrorISR:</em> <b>osMessageQueueReset</b> cannot be called from interrupt service routines.</li>
 681 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 682 </ul>
 683 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 684
 685 </div>
 686 </div>
 687 <a id="gaba987f665444e0d83fa6a3a68bc72abe" name="gaba987f665444e0d83fa6a3a68bc72abe"></a>
 688 <h2 class="memtitle"><span class="permalink"><a href="#gaba987f665444e0d83fa6a3a68bc72abe">&#9670;&#160;</a></span>osMessageQueueDelete()</h2>
 689
 690 <div class="memitem">
 691 <div class="memproto">
 692       <table class="memname">
 693         <tr>
 694           <td class="memname"><a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> osMessageQueueDelete </td>
 695           <td>(</td>
 696           <td class="paramtype">osMessageQueueId_t&#160;</td>
 697           <td class="paramname"><em>mq_id</em></td><td>)</td>
 698           <td></td>
 699         </tr>
 700       </table>
 701 </div><div class="memdoc">
 702
 703 <p>Delete a Message Queue object. </p>
 704 <dl class="params"><dt>Parameters</dt><dd>
 705   <table class="params">
 706     <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>
 707   </table>
 708   </dd>
 709 </dl>
 710 <dl class="section return"><dt>Returns</dt><dd>status code that indicates the execution status of the function.</dd></dl>
 711 <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>
 712 <p>Possible <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> return values:</p><ul>
 713 <li><em>osOK:</em> the message queue object has been deleted.</li>
 714 <li><em>osErrorParameter:</em> parameter <em>mq_id</em> is <span class="XML-Token">NULL</span> or invalid.</li>
 715 <li><em>osErrorResource:</em> the message queue is in an invalid state.</li>
 716 <li><em>osErrorISR:</em> <b>osMessageQueueDelete</b> cannot be called from interrupt service routines.</li>
 717 <li><em>osErrorSafetyClass:</em> the calling thread safety class is lower than the safety class of the specified message queue.</li>
 718 </ul>
 719 <dl class="section note"><dt>Note</dt><dd>This function <b>cannot</b> be called from <a class="el" href="usingOS2.html#CMSIS_RTOS_ISR_Calls">Interrupt Service Routines</a>. </dd></dl>
 720
 721 </div>
 722 </div>
 723 </div><!-- contents -->
 724 </div><!-- doc-content -->
 725 <!-- start footer part -->
 726 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 727   <ul>
 728     <li class="footer">
 729       <script type="text/javascript">
 730         <!--
 731         writeFooter.call(this);
 732         //-->
 733       </script>
 734     </li>
 735   </ul>
 736 </div>
 737 </body>
 738 </html>