gnuk/ChibiOS_2.0.8/docs/html/chlists_8h.html
2010-11-30 13:54:43 +09:00

97 lines
11 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ChibiOS/RT: chlists.h File Reference</title>
<link href="custom.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<table style="text-align: center; width: 100%;" border="0"
cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
<td style="width: 80px;"></td>
</tr>
</tbody>
</table>
<hr size="1">
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>chlists.h File Reference</h1> </div>
</div>
<div class="contents">
<p><a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> queues/lists macros and structures.
<a href="#_details">More...</a></p>
<p><a href="chlists_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_threads_queue.html">ThreadsQueue</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic threads bidirectional linked list header and element. <a href="struct_threads_queue.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_threads_list.html">ThreadsList</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic threads single link list, it works like a stack. <a href="struct_threads_list.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#ga6d19d0f3ff1fa599b6d9783dec180451">queue_init</a>(tqp)&nbsp;&nbsp;&nbsp;((tqp)-&gt;p_next = (tqp)-&gt;p_prev = (<a class="el" href="struct_thread.html">Thread</a> *)(tqp));</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Threads queue initialization. <a href="group__internals.html#ga6d19d0f3ff1fa599b6d9783dec180451"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#gaaef72a9005ecd65e7b5c22e95ad82388">list_init</a>(tlp)&nbsp;&nbsp;&nbsp;((tlp)-&gt;p_next = (<a class="el" href="struct_thread.html">Thread</a> *)(tlp))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Threads list initialization. <a href="group__internals.html#gaaef72a9005ecd65e7b5c22e95ad82388"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#gadf402c10356566d82a6631c102b7f656">isempty</a>(p)&nbsp;&nbsp;&nbsp;((p)-&gt;p_next == (<a class="el" href="struct_thread.html">Thread</a> *)(p))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates to <code>TRUE</code> if the specified threads queue or list is empty. <a href="group__internals.html#gadf402c10356566d82a6631c102b7f656"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#ga8f6bea56a53acc44758fe61c98d68a4e">notempty</a>(p)&nbsp;&nbsp;&nbsp;((p)-&gt;p_next != (<a class="el" href="struct_thread.html">Thread</a> *)(p))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates to <code>TRUE</code> if the specified threads queue or list is not empty. <a href="group__internals.html#ga8f6bea56a53acc44758fe61c98d68a4e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#ga9ac5ac4cb62a9baa48d2004876852112">_THREADSQUEUE_DATA</a>(name)&nbsp;&nbsp;&nbsp;{(<a class="el" href="struct_thread.html">Thread</a> *)&amp;name, (<a class="el" href="struct_thread.html">Thread</a> *)&amp;name}</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Data part of a static threads queue initializer. <a href="group__internals.html#ga9ac5ac4cb62a9baa48d2004876852112"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#ga08959a4e3dd5e492734970618a56078c">THREADSQUEUE_DECL</a>(name)&nbsp;&nbsp;&nbsp;<a class="el" href="struct_threads_queue.html">ThreadsQueue</a> name = _THREADSQUEUE_DATA(name)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static threads queue initializer. <a href="group__internals.html#ga08959a4e3dd5e492734970618a56078c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#ga02226b866ae704435baf2ffe259ba0b2">prio_insert</a> (<a class="el" href="struct_thread.html">Thread</a> *tp, <a class="el" href="struct_threads_queue.html">ThreadsQueue</a> *tqp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inserts a thread into a priority ordered queue. <a href="group__internals.html#ga02226b866ae704435baf2ffe259ba0b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#gaf7072f75fdab9dcc5f7b8dcad212965c">queue_insert</a> (<a class="el" href="struct_thread.html">Thread</a> *tp, <a class="el" href="struct_threads_queue.html">ThreadsQueue</a> *tqp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inserts a <a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> into a queue. <a href="group__internals.html#gaf7072f75fdab9dcc5f7b8dcad212965c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_thread.html">Thread</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a">fifo_remove</a> (<a class="el" href="struct_threads_queue.html">ThreadsQueue</a> *tqp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes the first-out <a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> from a queue and returns it. <a href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_thread.html">Thread</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#gacacfe77140cab62948e63d898bf4dfba">lifo_remove</a> (<a class="el" href="struct_threads_queue.html">ThreadsQueue</a> *tqp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes the last-out <a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> from a queue and returns it. <a href="group__internals.html#gacacfe77140cab62948e63d898bf4dfba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_thread.html">Thread</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#gafff11bcd31d7dc3d1a0a6c66f3fc6ec9">dequeue</a> (<a class="el" href="struct_thread.html">Thread</a> *tp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a <a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> from a queue and returns it. <a href="group__internals.html#gafff11bcd31d7dc3d1a0a6c66f3fc6ec9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#ga5818ce2d363d36402baece614b06e41b">list_insert</a> (<a class="el" href="struct_thread.html">Thread</a> *tp, <a class="el" href="struct_threads_list.html">ThreadsList</a> *tlp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pushes a <a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> on top of a stack list. <a href="group__internals.html#ga5818ce2d363d36402baece614b06e41b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_thread.html">Thread</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internals.html#gad9aa523aebdaeefa3cc4a311bc210e8a">list_remove</a> (<a class="el" href="struct_threads_list.html">ThreadsList</a> *tlp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pops a <a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> from the top of a stack list and returns it. <a href="group__internals.html#gad9aa523aebdaeefa3cc4a311bc210e8a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> queues/lists macros and structures. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>All the macros present in this module, while public, are not an OS API and should not be directly used in the user applications code. </dd></dl>
<p>Definition in file <a class="el" href="chlists_8h_source.html">chlists.h</a>.</p>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Nov 28 2010 14:09:49 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
</body>
</html>