web/docs/group__queue.html

   1 <!-- HTML header for doxygen 1.8.20-->
   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">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: queue</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v1.5.1
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('group__queue.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#func-members">Functions</a>  </div>
 107   <div class="headertitle"><div class="title">queue<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a> &raquo; <a class="el" href="group__pico__util.html">pico_util</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110 <table class="memberdecls">
 111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 112 Functions</h2></td></tr>
 113 <tr class="memitem:ga6b379b09df9ac326e3c07a2727b7ca96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga6b379b09df9ac326e3c07a2727b7ca96">queue_init_with_spinlock</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, uint element_size, uint element_count, uint spinlock_num)</td></tr>
 114 <tr class="memdesc:ga6b379b09df9ac326e3c07a2727b7ca96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a queue with a specific spinlock for concurrency protection.  <a href="group__queue.html#ga6b379b09df9ac326e3c07a2727b7ca96">More...</a><br /></td></tr>
 115 <tr class="separator:ga6b379b09df9ac326e3c07a2727b7ca96"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 <tr class="memitem:ga0aa8e36b5c51158d836e16c5be2b9925"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga0aa8e36b5c51158d836e16c5be2b9925">queue_init</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, uint element_size, uint element_count)</td></tr>
 117 <tr class="memdesc:ga0aa8e36b5c51158d836e16c5be2b9925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a queue, allocating a (possibly shared) spinlock.  <a href="group__queue.html#ga0aa8e36b5c51158d836e16c5be2b9925">More...</a><br /></td></tr>
 118 <tr class="separator:ga0aa8e36b5c51158d836e16c5be2b9925"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="memitem:gaa13034dd0decdb0faf1b863383560be2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gaa13034dd0decdb0faf1b863383560be2">queue_free</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q)</td></tr>
 120 <tr class="memdesc:gaa13034dd0decdb0faf1b863383560be2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the specified queue.  <a href="group__queue.html#gaa13034dd0decdb0faf1b863383560be2">More...</a><br /></td></tr>
 121 <tr class="separator:gaa13034dd0decdb0faf1b863383560be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:ga2ebf4d2dec7ad019b03c2994defdf046"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga2ebf4d2dec7ad019b03c2994defdf046">queue_get_level_unsafe</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q)</td></tr>
 123 <tr class="memdesc:ga2ebf4d2dec7ad019b03c2994defdf046"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsafe check of level of the specified queue.  <a href="group__queue.html#ga2ebf4d2dec7ad019b03c2994defdf046">More...</a><br /></td></tr>
 124 <tr class="separator:ga2ebf4d2dec7ad019b03c2994defdf046"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:ga5cc5a58d2cac83f33aac5e8bb4e35147"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga5cc5a58d2cac83f33aac5e8bb4e35147">queue_get_level</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q)</td></tr>
 126 <tr class="memdesc:ga5cc5a58d2cac83f33aac5e8bb4e35147"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check of level of the specified queue.  <a href="group__queue.html#ga5cc5a58d2cac83f33aac5e8bb4e35147">More...</a><br /></td></tr>
 127 <tr class="separator:ga5cc5a58d2cac83f33aac5e8bb4e35147"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:ga8456f240608d3e58e5323bedadaeebe2"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga8456f240608d3e58e5323bedadaeebe2">queue_is_empty</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q)</td></tr>
 129 <tr class="memdesc:ga8456f240608d3e58e5323bedadaeebe2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if queue is empty.  <a href="group__queue.html#ga8456f240608d3e58e5323bedadaeebe2">More...</a><br /></td></tr>
 130 <tr class="separator:ga8456f240608d3e58e5323bedadaeebe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:gaed8287f549f6065fc89c5b56b9f9212e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gaed8287f549f6065fc89c5b56b9f9212e">queue_is_full</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q)</td></tr>
 132 <tr class="memdesc:gaed8287f549f6065fc89c5b56b9f9212e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if queue is full.  <a href="group__queue.html#gaed8287f549f6065fc89c5b56b9f9212e">More...</a><br /></td></tr>
 133 <tr class="separator:gaed8287f549f6065fc89c5b56b9f9212e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:ga42ddfda77fa6e9c6292deda62d993ae3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga42ddfda77fa6e9c6292deda62d993ae3">queue_try_add</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, const void *data)</td></tr>
 135 <tr class="memdesc:ga42ddfda77fa6e9c6292deda62d993ae3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-blocking add value queue if not full.  <a href="group__queue.html#ga42ddfda77fa6e9c6292deda62d993ae3">More...</a><br /></td></tr>
 136 <tr class="separator:ga42ddfda77fa6e9c6292deda62d993ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:ga31806423ac9c0b39ee7bb6473aa8d253"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga31806423ac9c0b39ee7bb6473aa8d253">queue_try_remove</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, void *data)</td></tr>
 138 <tr class="memdesc:ga31806423ac9c0b39ee7bb6473aa8d253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-blocking removal of entry from the queue if non empty.  <a href="group__queue.html#ga31806423ac9c0b39ee7bb6473aa8d253">More...</a><br /></td></tr>
 139 <tr class="separator:ga31806423ac9c0b39ee7bb6473aa8d253"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:gab2d65c218a1826243d64f6305417dcc0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gab2d65c218a1826243d64f6305417dcc0">queue_try_peek</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, void *data)</td></tr>
 141 <tr class="memdesc:gab2d65c218a1826243d64f6305417dcc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non-blocking peek at the next item to be removed from the queue.  <a href="group__queue.html#gab2d65c218a1826243d64f6305417dcc0">More...</a><br /></td></tr>
 142 <tr class="separator:gab2d65c218a1826243d64f6305417dcc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:gad01f5e5ddf3403416097f31acc2dbeca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gad01f5e5ddf3403416097f31acc2dbeca">queue_add_blocking</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, const void *data)</td></tr>
 144 <tr class="memdesc:gad01f5e5ddf3403416097f31acc2dbeca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking add of value to queue.  <a href="group__queue.html#gad01f5e5ddf3403416097f31acc2dbeca">More...</a><br /></td></tr>
 145 <tr class="separator:gad01f5e5ddf3403416097f31acc2dbeca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ga97fb187c127e26935b37785692d1776b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga97fb187c127e26935b37785692d1776b">queue_remove_blocking</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, void *data)</td></tr>
 147 <tr class="memdesc:ga97fb187c127e26935b37785692d1776b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking remove entry from queue.  <a href="group__queue.html#ga97fb187c127e26935b37785692d1776b">More...</a><br /></td></tr>
 148 <tr class="separator:ga97fb187c127e26935b37785692d1776b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:ga104ec5baa82c9635163a511df7abf124"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga104ec5baa82c9635163a511df7abf124">queue_peek_blocking</a> (<a class="el" href="structqueue__t.html">queue_t</a> *q, void *data)</td></tr>
 150 <tr class="memdesc:ga104ec5baa82c9635163a511df7abf124"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking peek at next value to be removed from queue.  <a href="group__queue.html#ga104ec5baa82c9635163a511df7abf124">More...</a><br /></td></tr>
 151 <tr class="separator:ga104ec5baa82c9635163a511df7abf124"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 </table>
 153 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 154 <p >Multi-core and IRQ safe queue implementation.</p>
 155 <p >Note that this queue stores values of a specified size, and pushed values are copied into the queue </p>
 156 <h2 class="groupheader">Function Documentation</h2>
 157 <a id="gad01f5e5ddf3403416097f31acc2dbeca" name="gad01f5e5ddf3403416097f31acc2dbeca"></a>
 158 <h2 class="memtitle"><span class="permalink"><a href="#gad01f5e5ddf3403416097f31acc2dbeca">&#9670;&nbsp;</a></span>queue_add_blocking()</h2>
 159
 160 <div class="memitem">
 161 <div class="memproto">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname">void queue_add_blocking </td>
 165           <td>(</td>
 166           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 167           <td class="paramname"><em>q</em>, </td>
 168         </tr>
 169         <tr>
 170           <td class="paramkey"></td>
 171           <td></td>
 172           <td class="paramtype">const void *&#160;</td>
 173           <td class="paramname"><em>data</em>&#160;</td>
 174         </tr>
 175         <tr>
 176           <td></td>
 177           <td>)</td>
 178           <td></td><td></td>
 179         </tr>
 180       </table>
 181 </div><div class="memdoc">
 182
 183 <p>Blocking add of value to queue. </p>
 184 <dl class="params"><dt>Parameters</dt><dd>
 185   <table class="params">
 186     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 187     <tr><td class="paramname">data</td><td>Pointer to value to be copied into the queue</td></tr>
 188   </table>
 189   </dd>
 190 </dl>
 191 <p>If the queue is full this function will block, until a removal happens on the queue </p>
 192
 193 </div>
 194 </div>
 195 <a id="gaa13034dd0decdb0faf1b863383560be2" name="gaa13034dd0decdb0faf1b863383560be2"></a>
 196 <h2 class="memtitle"><span class="permalink"><a href="#gaa13034dd0decdb0faf1b863383560be2">&#9670;&nbsp;</a></span>queue_free()</h2>
 197
 198 <div class="memitem">
 199 <div class="memproto">
 200       <table class="memname">
 201         <tr>
 202           <td class="memname">void queue_free </td>
 203           <td>(</td>
 204           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 205           <td class="paramname"><em>q</em></td><td>)</td>
 206           <td></td>
 207         </tr>
 208       </table>
 209 </div><div class="memdoc">
 210
 211 <p>Destroy the specified queue. </p>
 212 <dl class="params"><dt>Parameters</dt><dd>
 213   <table class="params">
 214     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle</td></tr>
 215   </table>
 216   </dd>
 217 </dl>
 218 <p>Does not deallocate the <a class="el" href="structqueue__t.html">queue_t</a> structure itself. </p>
 219
 220 </div>
 221 </div>
 222 <a id="ga5cc5a58d2cac83f33aac5e8bb4e35147" name="ga5cc5a58d2cac83f33aac5e8bb4e35147"></a>
 223 <h2 class="memtitle"><span class="permalink"><a href="#ga5cc5a58d2cac83f33aac5e8bb4e35147">&#9670;&nbsp;</a></span>queue_get_level()</h2>
 224
 225 <div class="memitem">
 226 <div class="memproto">
 227 <table class="mlabels">
 228   <tr>
 229   <td class="mlabels-left">
 230       <table class="memname">
 231         <tr>
 232           <td class="memname">static uint queue_get_level </td>
 233           <td>(</td>
 234           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 235           <td class="paramname"><em>q</em></td><td>)</td>
 236           <td></td>
 237         </tr>
 238       </table>
 239   </td>
 240   <td class="mlabels-right">
 241 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 242   </tr>
 243 </table>
 244 </div><div class="memdoc">
 245
 246 <p>Check of level of the specified queue. </p>
 247 <dl class="params"><dt>Parameters</dt><dd>
 248   <table class="params">
 249     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 250   </table>
 251   </dd>
 252 </dl>
 253 <dl class="section return"><dt>Returns</dt><dd>Number of entries in the queue </dd></dl>
 254
 255 </div>
 256 </div>
 257 <a id="ga2ebf4d2dec7ad019b03c2994defdf046" name="ga2ebf4d2dec7ad019b03c2994defdf046"></a>
 258 <h2 class="memtitle"><span class="permalink"><a href="#ga2ebf4d2dec7ad019b03c2994defdf046">&#9670;&nbsp;</a></span>queue_get_level_unsafe()</h2>
 259
 260 <div class="memitem">
 261 <div class="memproto">
 262 <table class="mlabels">
 263   <tr>
 264   <td class="mlabels-left">
 265       <table class="memname">
 266         <tr>
 267           <td class="memname">static uint queue_get_level_unsafe </td>
 268           <td>(</td>
 269           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 270           <td class="paramname"><em>q</em></td><td>)</td>
 271           <td></td>
 272         </tr>
 273       </table>
 274   </td>
 275   <td class="mlabels-right">
 276 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 277   </tr>
 278 </table>
 279 </div><div class="memdoc">
 280
 281 <p>Unsafe check of level of the specified queue. </p>
 282 <dl class="params"><dt>Parameters</dt><dd>
 283   <table class="params">
 284     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 285   </table>
 286   </dd>
 287 </dl>
 288 <dl class="section return"><dt>Returns</dt><dd>Number of entries in the queue</dd></dl>
 289 <p>This does not use the spinlock, so may return incorrect results if the spin lock is not externally locked </p>
 290
 291 </div>
 292 </div>
 293 <a id="ga0aa8e36b5c51158d836e16c5be2b9925" name="ga0aa8e36b5c51158d836e16c5be2b9925"></a>
 294 <h2 class="memtitle"><span class="permalink"><a href="#ga0aa8e36b5c51158d836e16c5be2b9925">&#9670;&nbsp;</a></span>queue_init()</h2>
 295
 296 <div class="memitem">
 297 <div class="memproto">
 298 <table class="mlabels">
 299   <tr>
 300   <td class="mlabels-left">
 301       <table class="memname">
 302         <tr>
 303           <td class="memname">static void queue_init </td>
 304           <td>(</td>
 305           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 306           <td class="paramname"><em>q</em>, </td>
 307         </tr>
 308         <tr>
 309           <td class="paramkey"></td>
 310           <td></td>
 311           <td class="paramtype">uint&#160;</td>
 312           <td class="paramname"><em>element_size</em>, </td>
 313         </tr>
 314         <tr>
 315           <td class="paramkey"></td>
 316           <td></td>
 317           <td class="paramtype">uint&#160;</td>
 318           <td class="paramname"><em>element_count</em>&#160;</td>
 319         </tr>
 320         <tr>
 321           <td></td>
 322           <td>)</td>
 323           <td></td><td></td>
 324         </tr>
 325       </table>
 326   </td>
 327   <td class="mlabels-right">
 328 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 329   </tr>
 330 </table>
 331 </div><div class="memdoc">
 332
 333 <p>Initialise a queue, allocating a (possibly shared) spinlock. </p>
 334 <dl class="params"><dt>Parameters</dt><dd>
 335   <table class="params">
 336     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 337     <tr><td class="paramname">element_size</td><td>Size of each value in the queue </td></tr>
 338     <tr><td class="paramname">element_count</td><td>Maximum number of entries in the queue </td></tr>
 339   </table>
 340   </dd>
 341 </dl>
 342
 343 </div>
 344 </div>
 345 <a id="ga6b379b09df9ac326e3c07a2727b7ca96" name="ga6b379b09df9ac326e3c07a2727b7ca96"></a>
 346 <h2 class="memtitle"><span class="permalink"><a href="#ga6b379b09df9ac326e3c07a2727b7ca96">&#9670;&nbsp;</a></span>queue_init_with_spinlock()</h2>
 347
 348 <div class="memitem">
 349 <div class="memproto">
 350       <table class="memname">
 351         <tr>
 352           <td class="memname">void queue_init_with_spinlock </td>
 353           <td>(</td>
 354           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 355           <td class="paramname"><em>q</em>, </td>
 356         </tr>
 357         <tr>
 358           <td class="paramkey"></td>
 359           <td></td>
 360           <td class="paramtype">uint&#160;</td>
 361           <td class="paramname"><em>element_size</em>, </td>
 362         </tr>
 363         <tr>
 364           <td class="paramkey"></td>
 365           <td></td>
 366           <td class="paramtype">uint&#160;</td>
 367           <td class="paramname"><em>element_count</em>, </td>
 368         </tr>
 369         <tr>
 370           <td class="paramkey"></td>
 371           <td></td>
 372           <td class="paramtype">uint&#160;</td>
 373           <td class="paramname"><em>spinlock_num</em>&#160;</td>
 374         </tr>
 375         <tr>
 376           <td></td>
 377           <td>)</td>
 378           <td></td><td></td>
 379         </tr>
 380       </table>
 381 </div><div class="memdoc">
 382
 383 <p>Initialise a queue with a specific spinlock for concurrency protection. </p>
 384 <dl class="params"><dt>Parameters</dt><dd>
 385   <table class="params">
 386     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 387     <tr><td class="paramname">element_size</td><td>Size of each value in the queue </td></tr>
 388     <tr><td class="paramname">element_count</td><td>Maximum number of entries in the queue </td></tr>
 389     <tr><td class="paramname">spinlock_num</td><td>The spin ID used to protect the queue </td></tr>
 390   </table>
 391   </dd>
 392 </dl>
 393
 394 </div>
 395 </div>
 396 <a id="ga8456f240608d3e58e5323bedadaeebe2" name="ga8456f240608d3e58e5323bedadaeebe2"></a>
 397 <h2 class="memtitle"><span class="permalink"><a href="#ga8456f240608d3e58e5323bedadaeebe2">&#9670;&nbsp;</a></span>queue_is_empty()</h2>
 398
 399 <div class="memitem">
 400 <div class="memproto">
 401 <table class="mlabels">
 402   <tr>
 403   <td class="mlabels-left">
 404       <table class="memname">
 405         <tr>
 406           <td class="memname">static bool queue_is_empty </td>
 407           <td>(</td>
 408           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 409           <td class="paramname"><em>q</em></td><td>)</td>
 410           <td></td>
 411         </tr>
 412       </table>
 413   </td>
 414   <td class="mlabels-right">
 415 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 416   </tr>
 417 </table>
 418 </div><div class="memdoc">
 419
 420 <p>Check if queue is empty. </p>
 421 <dl class="params"><dt>Parameters</dt><dd>
 422   <table class="params">
 423     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 424   </table>
 425   </dd>
 426 </dl>
 427 <dl class="section return"><dt>Returns</dt><dd>true if queue is empty, false otherwise</dd></dl>
 428 <p>This function is interrupt and multicore safe. </p>
 429
 430 </div>
 431 </div>
 432 <a id="gaed8287f549f6065fc89c5b56b9f9212e" name="gaed8287f549f6065fc89c5b56b9f9212e"></a>
 433 <h2 class="memtitle"><span class="permalink"><a href="#gaed8287f549f6065fc89c5b56b9f9212e">&#9670;&nbsp;</a></span>queue_is_full()</h2>
 434
 435 <div class="memitem">
 436 <div class="memproto">
 437 <table class="mlabels">
 438   <tr>
 439   <td class="mlabels-left">
 440       <table class="memname">
 441         <tr>
 442           <td class="memname">static bool queue_is_full </td>
 443           <td>(</td>
 444           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 445           <td class="paramname"><em>q</em></td><td>)</td>
 446           <td></td>
 447         </tr>
 448       </table>
 449   </td>
 450   <td class="mlabels-right">
 451 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 452   </tr>
 453 </table>
 454 </div><div class="memdoc">
 455
 456 <p>Check if queue is full. </p>
 457 <dl class="params"><dt>Parameters</dt><dd>
 458   <table class="params">
 459     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 460   </table>
 461   </dd>
 462 </dl>
 463 <dl class="section return"><dt>Returns</dt><dd>true if queue is full, false otherwise</dd></dl>
 464 <p>This function is interrupt and multicore safe. </p>
 465
 466 </div>
 467 </div>
 468 <a id="ga104ec5baa82c9635163a511df7abf124" name="ga104ec5baa82c9635163a511df7abf124"></a>
 469 <h2 class="memtitle"><span class="permalink"><a href="#ga104ec5baa82c9635163a511df7abf124">&#9670;&nbsp;</a></span>queue_peek_blocking()</h2>
 470
 471 <div class="memitem">
 472 <div class="memproto">
 473       <table class="memname">
 474         <tr>
 475           <td class="memname">void queue_peek_blocking </td>
 476           <td>(</td>
 477           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 478           <td class="paramname"><em>q</em>, </td>
 479         </tr>
 480         <tr>
 481           <td class="paramkey"></td>
 482           <td></td>
 483           <td class="paramtype">void *&#160;</td>
 484           <td class="paramname"><em>data</em>&#160;</td>
 485         </tr>
 486         <tr>
 487           <td></td>
 488           <td>)</td>
 489           <td></td><td></td>
 490         </tr>
 491       </table>
 492 </div><div class="memdoc">
 493
 494 <p>Blocking peek at next value to be removed from queue. </p>
 495 <dl class="params"><dt>Parameters</dt><dd>
 496   <table class="params">
 497     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 498     <tr><td class="paramname">data</td><td>Pointer to the location to receive the peeked value</td></tr>
 499   </table>
 500   </dd>
 501 </dl>
 502 <p>If the queue is empty function will block until a value is added </p>
 503
 504 </div>
 505 </div>
 506 <a id="ga97fb187c127e26935b37785692d1776b" name="ga97fb187c127e26935b37785692d1776b"></a>
 507 <h2 class="memtitle"><span class="permalink"><a href="#ga97fb187c127e26935b37785692d1776b">&#9670;&nbsp;</a></span>queue_remove_blocking()</h2>
 508
 509 <div class="memitem">
 510 <div class="memproto">
 511       <table class="memname">
 512         <tr>
 513           <td class="memname">void queue_remove_blocking </td>
 514           <td>(</td>
 515           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 516           <td class="paramname"><em>q</em>, </td>
 517         </tr>
 518         <tr>
 519           <td class="paramkey"></td>
 520           <td></td>
 521           <td class="paramtype">void *&#160;</td>
 522           <td class="paramname"><em>data</em>&#160;</td>
 523         </tr>
 524         <tr>
 525           <td></td>
 526           <td>)</td>
 527           <td></td><td></td>
 528         </tr>
 529       </table>
 530 </div><div class="memdoc">
 531
 532 <p>Blocking remove entry from queue. </p>
 533 <dl class="params"><dt>Parameters</dt><dd>
 534   <table class="params">
 535     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 536     <tr><td class="paramname">data</td><td>Pointer to the location to receive the removed value</td></tr>
 537   </table>
 538   </dd>
 539 </dl>
 540 <p>If the queue is empty this function will block until a value is added. </p>
 541
 542 </div>
 543 </div>
 544 <a id="ga42ddfda77fa6e9c6292deda62d993ae3" name="ga42ddfda77fa6e9c6292deda62d993ae3"></a>
 545 <h2 class="memtitle"><span class="permalink"><a href="#ga42ddfda77fa6e9c6292deda62d993ae3">&#9670;&nbsp;</a></span>queue_try_add()</h2>
 546
 547 <div class="memitem">
 548 <div class="memproto">
 549       <table class="memname">
 550         <tr>
 551           <td class="memname">bool queue_try_add </td>
 552           <td>(</td>
 553           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 554           <td class="paramname"><em>q</em>, </td>
 555         </tr>
 556         <tr>
 557           <td class="paramkey"></td>
 558           <td></td>
 559           <td class="paramtype">const void *&#160;</td>
 560           <td class="paramname"><em>data</em>&#160;</td>
 561         </tr>
 562         <tr>
 563           <td></td>
 564           <td>)</td>
 565           <td></td><td></td>
 566         </tr>
 567       </table>
 568 </div><div class="memdoc">
 569
 570 <p>Non-blocking add value queue if not full. </p>
 571 <dl class="params"><dt>Parameters</dt><dd>
 572   <table class="params">
 573     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 574     <tr><td class="paramname">data</td><td>Pointer to value to be copied into the queue </td></tr>
 575   </table>
 576   </dd>
 577 </dl>
 578 <dl class="section return"><dt>Returns</dt><dd>true if the value was added</dd></dl>
 579 <p>If the queue is full this function will return immediately with false, otherwise the data is copied into a new value added to the queue, and this function will return true. </p>
 580
 581 </div>
 582 </div>
 583 <a id="gab2d65c218a1826243d64f6305417dcc0" name="gab2d65c218a1826243d64f6305417dcc0"></a>
 584 <h2 class="memtitle"><span class="permalink"><a href="#gab2d65c218a1826243d64f6305417dcc0">&#9670;&nbsp;</a></span>queue_try_peek()</h2>
 585
 586 <div class="memitem">
 587 <div class="memproto">
 588       <table class="memname">
 589         <tr>
 590           <td class="memname">bool queue_try_peek </td>
 591           <td>(</td>
 592           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 593           <td class="paramname"><em>q</em>, </td>
 594         </tr>
 595         <tr>
 596           <td class="paramkey"></td>
 597           <td></td>
 598           <td class="paramtype">void *&#160;</td>
 599           <td class="paramname"><em>data</em>&#160;</td>
 600         </tr>
 601         <tr>
 602           <td></td>
 603           <td>)</td>
 604           <td></td><td></td>
 605         </tr>
 606       </table>
 607 </div><div class="memdoc">
 608
 609 <p>Non-blocking peek at the next item to be removed from the queue. </p>
 610 <dl class="params"><dt>Parameters</dt><dd>
 611   <table class="params">
 612     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 613     <tr><td class="paramname">data</td><td>Pointer to the location to receive the peeked value </td></tr>
 614   </table>
 615   </dd>
 616 </dl>
 617 <dl class="section return"><dt>Returns</dt><dd>true if there was a value to peek</dd></dl>
 618 <p>If the queue is not empty this function will return immediately with true with the peeked entry copied into the location specified by the data parameter, otherwise the function will return false. </p>
 619
 620 </div>
 621 </div>
 622 <a id="ga31806423ac9c0b39ee7bb6473aa8d253" name="ga31806423ac9c0b39ee7bb6473aa8d253"></a>
 623 <h2 class="memtitle"><span class="permalink"><a href="#ga31806423ac9c0b39ee7bb6473aa8d253">&#9670;&nbsp;</a></span>queue_try_remove()</h2>
 624
 625 <div class="memitem">
 626 <div class="memproto">
 627       <table class="memname">
 628         <tr>
 629           <td class="memname">bool queue_try_remove </td>
 630           <td>(</td>
 631           <td class="paramtype"><a class="el" href="structqueue__t.html">queue_t</a> *&#160;</td>
 632           <td class="paramname"><em>q</em>, </td>
 633         </tr>
 634         <tr>
 635           <td class="paramkey"></td>
 636           <td></td>
 637           <td class="paramtype">void *&#160;</td>
 638           <td class="paramname"><em>data</em>&#160;</td>
 639         </tr>
 640         <tr>
 641           <td></td>
 642           <td>)</td>
 643           <td></td><td></td>
 644         </tr>
 645       </table>
 646 </div><div class="memdoc">
 647
 648 <p>Non-blocking removal of entry from the queue if non empty. </p>
 649 <dl class="params"><dt>Parameters</dt><dd>
 650   <table class="params">
 651     <tr><td class="paramname">q</td><td>Pointer to a <a class="el" href="structqueue__t.html">queue_t</a> structure, used as a handle </td></tr>
 652     <tr><td class="paramname">data</td><td>Pointer to the location to receive the removed value </td></tr>
 653   </table>
 654   </dd>
 655 </dl>
 656 <dl class="section return"><dt>Returns</dt><dd>true if a value was removed</dd></dl>
 657 <p>If the queue is not empty function will copy the removed value into the location provided and return immediately with true, otherwise the function will return immediately with false. </p>
 658
 659 </div>
 660 </div>
 661 </div><!-- contents -->
 662 </div><!-- doc-content -->
 663
 664         <script src="main.js"></script>
 665 </body>
 666 </html>