📄 a00022.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>The Protothreads Library 1.4: pt.h Source File</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.4.6 --><div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li id="current"><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul></div><h1>pt.h</h1><a href="a00013.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span><a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2004-2005, Swedish Institute of Computer Science.</span><a name="l00003"></a>00003 <span class="comment"> * All rights reserved.</span><a name="l00004"></a>00004 <span class="comment"> *</span><a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span><a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions</span><a name="l00007"></a>00007 <span class="comment"> * are met:</span><a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span><a name="l00009"></a>00009 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span><a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span><a name="l00011"></a>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span><a name="l00012"></a>00012 <span class="comment"> * documentation and/or other materials provided with the distribution.</span><a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors</span><a name="l00014"></a>00014 <span class="comment"> * may be used to endorse or promote products derived from this software</span><a name="l00015"></a>00015 <span class="comment"> * without specific prior written permission.</span><a name="l00016"></a>00016 <span class="comment"> *</span><a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND</span><a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span><a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span><a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE</span><a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span><a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS</span><a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span><a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT</span><a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span><a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span><a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE.</span><a name="l00028"></a>00028 <span class="comment"> *</span><a name="l00029"></a>00029 <span class="comment"> * This file is part of the Contiki operating system.</span><a name="l00030"></a>00030 <span class="comment"> *</span><a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span><a name="l00032"></a>00032 <span class="comment"> *</span><a name="l00033"></a>00033 <span class="comment"> * $Id: pt.h,v 1.7 2006/10/02 07:52:56 adam Exp $</span><a name="l00034"></a>00034 <span class="comment"> */</span><a name="l00035"></a>00035 <span class="comment"></span><a name="l00036"></a>00036 <span class="comment">/**</span><a name="l00037"></a>00037 <span class="comment"> * \addtogroup pt</span><a name="l00038"></a>00038 <span class="comment"> * @{</span><a name="l00039"></a>00039 <span class="comment"> */</span><a name="l00040"></a>00040 <span class="comment"></span><a name="l00041"></a>00041 <span class="comment">/**</span><a name="l00042"></a>00042 <span class="comment"> * \file</span><a name="l00043"></a>00043 <span class="comment"> * Protothreads implementation.</span><a name="l00044"></a>00044 <span class="comment"> * \author</span><a name="l00045"></a>00045 <span class="comment"> * Adam Dunkels <adam@sics.se></span><a name="l00046"></a>00046 <span class="comment"> *</span><a name="l00047"></a>00047 <span class="comment"> */</span><a name="l00048"></a>00048 <a name="l00049"></a>00049 <span class="preprocessor">#ifndef __PT_H__</span><a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#define __PT_H__</span><a name="l00051"></a>00051 <span class="preprocessor"></span><a name="l00052"></a>00052 <span class="preprocessor">#include "<a class="code" href="a00011.html">lc.h</a>"</span><a name="l00053"></a>00053 <a name="l00054"></a><a class="code" href="a00005.html">00054</a> <span class="keyword">struct </span><a class="code" href="a00005.html">pt</a> {<a name="l00055"></a><a class="code" href="a00005.html#c3fa0fa86689e3e7c039a16c16861dbe">00055</a> <a class="code" href="a00017.html#gfad6704adb116cc16edb80f744e7239d">lc_t</a> <a class="code" href="a00005.html#c3fa0fa86689e3e7c039a16c16861dbe">lc</a>;<a name="l00056"></a>00056 };<a name="l00057"></a>00057 <a name="l00058"></a><a class="code" href="a00014.html#g7b5319b5b65761a845fcd1500fde4cdc">00058</a> <span class="preprocessor">#define PT_WAITING 0</span><a name="l00059"></a><a class="code" href="a00014.html#ge469332907e0617d72d5e2dd4297119d">00059</a> <span class="preprocessor"></span><span class="preprocessor">#define PT_YIELDED 1</span><a name="l00060"></a><a class="code" href="a00014.html#gcfae9053e5c107a1aed6b228c917d2ea">00060</a> <span class="preprocessor"></span><span class="preprocessor">#define PT_EXITED 2</span><a name="l00061"></a><a class="code" href="a00014.html#g9ff1e8936a8a26bff54c05f8a989b93b">00061</a> <span class="preprocessor"></span><span class="preprocessor">#define PT_ENDED 3</span><a name="l00062"></a>00062 <span class="preprocessor"></span><span class="comment"></span><a name="l00063"></a>00063 <span class="comment">/**</span><a name="l00064"></a>00064 <span class="comment"> * \name Initialization</span><a name="l00065"></a>00065 <span class="comment"> * @{</span><a name="l00066"></a>00066 <span class="comment"> */</span><a name="l00067"></a>00067 <span class="comment"></span><a name="l00068"></a>00068 <span class="comment">/**</span><a name="l00069"></a>00069 <span class="comment"> * Initialize a protothread.</span><a name="l00070"></a>00070 <span class="comment"> *</span><a name="l00071"></a>00071 <span class="comment"> * Initializes a protothread. Initialization must be done prior to</span><a name="l00072"></a>00072 <span class="comment"> * starting to execute the protothread.</span><a name="l00073"></a>00073 <span class="comment"> *</span><a name="l00074"></a>00074 <span class="comment"> * \param pt A pointer to the protothread control structure.</span><a name="l00075"></a>00075 <span class="comment"> *</span><a name="l00076"></a>00076 <span class="comment"> * \sa PT_SPAWN()</span><a name="l00077"></a>00077 <span class="comment"> *</span><a name="l00078"></a>00078 <span class="comment"> * \hideinitializer</span><a name="l00079"></a>00079 <span class="comment"> */</span><a name="l00080"></a><a class="code" href="a00014.html#ge6bae7dc0225468c8a5ac269df549892">00080</a> <span class="preprocessor">#define PT_INIT(pt) LC_INIT((pt)->lc)</span><a name="l00081"></a>00081 <span class="preprocessor"></span><span class="comment"></span><a name="l00082"></a>00082 <span class="comment">/** @} */</span><a name="l00083"></a>00083 <span class="comment"></span><a name="l00084"></a>00084 <span class="comment">/**</span><a name="l00085"></a>00085 <span class="comment"> * \name Declaration and definition</span><a name="l00086"></a>00086 <span class="comment"> * @{</span><a name="l00087"></a>00087 <span class="comment"> */</span><a name="l00088"></a>00088 <span class="comment"></span><a name="l00089"></a>00089 <span class="comment">/**</span><a name="l00090"></a>00090 <span class="comment"> * Declaration of a protothread.</span><a name="l00091"></a>00091 <span class="comment"> *</span><a name="l00092"></a>00092 <span class="comment"> * This macro is used to declare a protothread. All protothreads must</span><a name="l00093"></a>00093 <span class="comment"> * be declared with this macro.</span><a name="l00094"></a>00094 <span class="comment"> *</span><a name="l00095"></a>00095 <span class="comment"> * \param name_args The name and arguments of the C function</span><a name="l00096"></a>00096 <span class="comment"> * implementing the protothread.</span><a name="l00097"></a>00097 <span class="comment"> *</span><a name="l00098"></a>00098 <span class="comment"> * \hideinitializer</span><a name="l00099"></a>00099 <span class="comment"> */</span><a name="l00100"></a><a class="code" href="a00014.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">00100</a> <span class="preprocessor">#define PT_THREAD(name_args) char name_args</span><a name="l00101"></a>00101 <span class="preprocessor"></span><span class="comment"></span><a name="l00102"></a>00102 <span class="comment">/**</span><a name="l00103"></a>00103 <span class="comment"> * Declare the start of a protothread inside the C function</span><a name="l00104"></a>00104 <span class="comment"> * implementing the protothread.</span><a name="l00105"></a>00105 <span class="comment"> *</span><a name="l00106"></a>00106 <span class="comment"> * This macro is used to declare the starting point of a</span><a name="l00107"></a>00107 <span class="comment"> * protothread. It should be placed at the start of the function in</span><a name="l00108"></a>00108 <span class="comment"> * which the protothread runs. All C statements above the PT_BEGIN()</span><a name="l00109"></a>00109 <span class="comment"> * invokation will be executed each time the protothread is scheduled.</span><a name="l00110"></a>00110 <span class="comment"> *</span><a name="l00111"></a>00111 <span class="comment"> * \param pt A pointer to the protothread control structure.</span><a name="l00112"></a>00112 <span class="comment"> *</span><a name="l00113"></a>00113 <span class="comment"> * \hideinitializer</span><a name="l00114"></a>00114 <span class="comment"> */</span><a name="l00115"></a><a class="code" href="a00014.html#g2ffbb9e554e08a343ae2f9de4bedfdfc">00115</a> <span class="preprocessor">#define PT_BEGIN(pt) { char PT_YIELD_FLAG = 1; LC_RESUME((pt)->lc)</span><a name="l00116"></a>00116 <span class="preprocessor"></span><span class="comment"></span><a name="l00117"></a>00117 <span class="comment">/**</span><a name="l00118"></a>00118 <span class="comment"> * Declare the end of a protothread.</span><a name="l00119"></a>00119 <span class="comment"> *</span><a name="l00120"></a>00120 <span class="comment"> * This macro is used for declaring that a protothread ends. It must</span><a name="l00121"></a>00121 <span class="comment"> * always be used together with a matching PT_BEGIN() macro.</span><a name="l00122"></a>00122 <span class="comment"> *</span><a name="l00123"></a>00123 <span class="comment"> * \param pt A pointer to the protothread control structure.</span><a name="l00124"></a>00124 <span class="comment"> *</span><a name="l00125"></a>00125 <span class="comment"> * \hideinitializer</span><a name="l00126"></a>00126 <span class="comment"> */</span><a name="l00127"></a><a class="code" href="a00014.html#g7b04a0035bef29d905496c23bae066d2">00127</a> <span class="preprocessor">#define PT_END(pt) LC_END((pt)->lc); PT_YIELD_FLAG = 0; \</span><a name="l00128"></a>00128 <span class="preprocessor"> PT_INIT(pt); return PT_ENDED; }</span><a name="l00129"></a>00129 <span class="preprocessor"></span><span class="comment"></span><a name="l00130"></a>00130 <span class="comment">/** @} */</span><a name="l00131"></a>00131 <span class="comment"></span><a name="l00132"></a>00132 <span class="comment">/**</span><a name="l00133"></a>00133 <span class="comment"> * \name Blocked wait</span><a name="l00134"></a>00134 <span class="comment"> * @{</span><a name="l00135"></a>00135 <span class="comment"> */</span><a name="l00136"></a>00136 <span class="comment"></span><a name="l00137"></a>00137 <span class="comment">/**</span><a name="l00138"></a>00138 <span class="comment"> * Block and wait until condition is true.</span><a name="l00139"></a>00139 <span class="comment"> *</span><a name="l00140"></a>00140 <span class="comment"> * This macro blocks the protothread until the specified condition is</span><a name="l00141"></a>00141 <span class="comment"> * true.</span><a name="l00142"></a>00142 <span class="comment"> *</span><a name="l00143"></a>00143 <span class="comment"> * \param pt A pointer to the protothread control structure.</span><a name="l00144"></a>00144 <span class="comment"> * \param condition The condition.</span><a name="l00145"></a>00145 <span class="comment"> *</span><a name="l00146"></a>00146 <span class="comment"> * \hideinitializer</span><a name="l00147"></a>00147 <span class="comment"> */</span><a name="l00148"></a><a class="code" href="a00014.html#g99e43010ec61327164466aa2d902de45">00148</a> <span class="preprocessor">#define PT_WAIT_UNTIL(pt, condition) \</span><a name="l00149"></a>00149 <span class="preprocessor"> do { \</span><a name="l00150"></a>00150 <span class="preprocessor"> LC_SET((pt)->lc); \</span><a name="l00151"></a>00151 <span class="preprocessor"> if(!(condition)) { \</span><a name="l00152"></a>00152 <span class="preprocessor"> return PT_WAITING; \</span><a name="l00153"></a>00153 <span class="preprocessor"> } \</span><a name="l00154"></a>00154 <span class="preprocessor"> } while(0)</span><a name="l00155"></a>00155 <span class="preprocessor"></span><span class="comment"></span>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -