structos_message_q_def__t.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>CMSIS-RTOS: osMessageQDef_t Struct Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. </script>
  17. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <script type="text/javascript">
  20. $(document).ready(function() { searchBox.OnSelectItem(0); });
  21. </script>
  22. <link href="stylsheetf" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 46px;">
  30. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  31. <td style="padding-left: 0.5em;">
  32. <div id="projectname">CMSIS-RTOS
  33. &#160;<span id="projectnumber">Version 1.02</span>
  34. </div>
  35. <div id="projectbrief">CMSIS-RTOS API: Generic RTOS interface for Cortex-M processor-based devices.</div>
  36. </td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. </div>
  41. <!-- end header part -->
  42. <div id="CMSISnav" class="tabs1">
  43. <ul class="tablist">
  44. <li><a href="../../General/html/index.html"><span>CMSIS</span></a></li>
  45. <li><a href="../../Core/html/index.html"><span>CORE</span></a></li>
  46. <li><a href="../../Driver/html/index.html"><span>Driver</span></a></li>
  47. <li><a href="../../DSP/html/index.html"><span>DSP</span></a></li>
  48. <li class="current"><a href="../../RTOS/html/index.html"><span>RTOS API</span></a></li>
  49. <li><a href="../../Pack/html/index.html"><span>Pack</span></a></li>
  50. <li><a href="../../SVD/html/index.html"><span>SVD</span></a></li>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.2 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. <div id="navrow2" class="tabs2">
  81. <ul class="tablist">
  82. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  83. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  84. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  85. </ul>
  86. </div>
  87. </div><!-- top -->
  88. <div id="side-nav" class="ui-resizable side-nav-resizable">
  89. <div id="nav-tree">
  90. <div id="nav-tree-contents">
  91. <div id="nav-sync" class="sync"></div>
  92. </div>
  93. </div>
  94. <div id="splitbar" style="-moz-user-select:none;"
  95. class="ui-resizable-handle">
  96. </div>
  97. </div>
  98. <script type="text/javascript">
  99. $(document).ready(function(){initNavTree('structos_message_q_def__t.html','');});
  100. </script>
  101. <div id="doc-content">
  102. <!-- window showing the filter options -->
  103. <div id="MSearchSelectWindow"
  104. onmouseover="return searchBox.OnSearchSelectShow()"
  105. onmouseout="return searchBox.OnSearchSelectHide()"
  106. onkeydown="return searchBox.OnSearchSelectKey(event)">
  107. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  108. <!-- iframe showing the search results (closed by default) -->
  109. <div id="MSearchResultsWindow">
  110. <iframe src="javascript:void(0)" frameborder="0"
  111. name="MSearchResults" id="MSearchResults">
  112. </iframe>
  113. </div>
  114. <div class="header">
  115. <div class="summary">
  116. <a href="#pub-attribs">Data Fields</a> </div>
  117. <div class="headertitle">
  118. <div class="title">osMessageQDef_t Struct Reference</div> </div>
  119. </div><!--header-->
  120. <div class="contents">
  121. <p>Definition structure for message queue.
  122. <a href="structos_message_q_def__t.html#details">More...</a></p>
  123. <table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  125. Data Fields</h2></td></tr>
  126. <tr class="memitem:a8a83a3a8c0aa8057b13807d2a54077e0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structos_message_q_def__t.html#a8a83a3a8c0aa8057b13807d2a54077e0">queue_sz</a></td></tr>
  127. <tr class="memdesc:a8a83a3a8c0aa8057b13807d2a54077e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of elements in the queue <a href="#a8a83a3a8c0aa8057b13807d2a54077e0"></a><br/></td></tr>
  128. <tr class="separator:a8a83a3a8c0aa8057b13807d2a54077e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a4c2a0c691de3365c00ecd22d8102811f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structos_message_q_def__t.html#a4c2a0c691de3365c00ecd22d8102811f">item_sz</a></td></tr>
  130. <tr class="memdesc:a4c2a0c691de3365c00ecd22d8102811f"><td class="mdescLeft">&#160;</td><td class="mdescRight">size of an item <a href="#a4c2a0c691de3365c00ecd22d8102811f"></a><br/></td></tr>
  131. <tr class="separator:a4c2a0c691de3365c00ecd22d8102811f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a269c3935f8bc66db70bccdd02cb05e3c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structos_message_q_def__t.html#a269c3935f8bc66db70bccdd02cb05e3c">pool</a></td></tr>
  133. <tr class="memdesc:a269c3935f8bc66db70bccdd02cb05e3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">memory array for messages <a href="#a269c3935f8bc66db70bccdd02cb05e3c"></a><br/></td></tr>
  134. <tr class="separator:a269c3935f8bc66db70bccdd02cb05e3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
  137. <div class="textblock"><dl class="section note"><dt>Note</dt><dd>CAN BE CHANGED: <b>os_messageQ_def</b> is implementation specific in every CMSIS-RTOS. </dd></dl>
  138. </div><h2 class="groupheader">Field Documentation</h2>
  139. <a class="anchor" id="a4c2a0c691de3365c00ecd22d8102811f"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">uint32_t item_sz</td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. </div>
  149. </div>
  150. <a class="anchor" id="a269c3935f8bc66db70bccdd02cb05e3c"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">void* pool</td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. </div>
  160. </div>
  161. <a class="anchor" id="a8a83a3a8c0aa8057b13807d2a54077e0"></a>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">uint32_t queue_sz</td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. </div>
  171. </div>
  172. </div><!-- contents -->
  173. </div><!-- doc-content -->
  174. <!-- start footer part -->
  175. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  176. <ul>
  177. <li class="navelem"><a class="el" href="structos_message_q_def__t.html">osMessageQDef_t</a></li>
  178. <li class="footer">Generated on Tue Sep 23 2014 18:52:52 for CMSIS-RTOS by ARM Ltd. All rights reserved.
  179. <!--
  180. <a href="http://www.doxygen.org/index.html">
  181. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2
  182. -->
  183. </li>
  184. </ul>
  185. </div>
  186. </body>
  187. </html>