📄 a00019.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.0: pt.h Source File</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.6 --><div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>pt.h</h1><a href="a00011.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>00002 <span class="comment"> * Copyright (c) 2004-2005, Swedish Institute of Computer Science.</span>00003 <span class="comment"> * All rights reserved. </span>00004 <span class="comment"> *</span>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>00007 <span class="comment"> * are met: </span>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>00009 <span class="comment"> * notice, this list of conditions and the following disclaimer. </span>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the </span>00012 <span class="comment"> * documentation and/or other materials provided with the distribution. </span>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors </span>00014 <span class="comment"> * may be used to endorse or promote products derived from this software </span>00015 <span class="comment"> * without specific prior written permission. </span>00016 <span class="comment"> *</span>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>00020 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>00027 <span class="comment"> * SUCH DAMAGE. </span>00028 <span class="comment"> *</span>00029 <span class="comment"> * This file is part of the protothreads library.</span>00030 <span class="comment"> * </span>00031 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>00032 <span class="comment"> *</span>00033 <span class="comment"> * $Id: pt.h,v 1.2 2005/02/24 10:36:59 adam Exp $</span>00034 <span class="comment"> */</span>00035 <span class="comment"></span>00036 <span class="comment">/**</span>00037 <span class="comment"> * \addtogroup pt</span>00038 <span class="comment"> * @{</span>00039 <span class="comment"> */</span>00040 <span class="comment"></span>00041 <span class="comment">/**</span>00042 <span class="comment"> * \file</span>00043 <span class="comment"> * Protothreads implementation.</span>00044 <span class="comment"> * \author</span>00045 <span class="comment"> * Adam Dunkels <adam@sics.se></span>00046 <span class="comment"> *</span>00047 <span class="comment"> */</span>00048 00049 <span class="preprocessor">#ifndef __PT_H__</span>00050 <span class="preprocessor"></span><span class="preprocessor">#define __PT_H__</span>00051 <span class="preprocessor"></span>00052 <span class="preprocessor">#include "<a class="code" href="a00009.html">lc.h</a>"</span>00053 00054 <span class="keyword">struct </span>pt {00055 <a class="code" href="a00014.html#ga0">lc_t</a> lc;00056 };00057 00058 <span class="preprocessor">#define PT_THREAD_WAITING 0</span>00059 <span class="preprocessor"></span><span class="preprocessor">#define PT_THREAD_EXITED 1</span>00060 <span class="preprocessor"></span><span class="comment"></span>00061 <span class="comment">/**</span>00062 <span class="comment"> * Declaration of a protothread.</span>00063 <span class="comment"> *</span>00064 <span class="comment"> * This macro is used to declare a protothread. All protothreads must</span>00065 <span class="comment"> * be declared with this macro.</span>00066 <span class="comment"> *</span>00067 <span class="comment"> * Example:</span>00068 <span class="comment"> \code</span>00069 <span class="comment"> PT_THREAD(consumer(struct pt *p, int event)) {</span>00070 <span class="comment"> PT_BEGIN(p);</span>00071 <span class="comment"> while(1) {</span>00072 <span class="comment"> PT_WAIT_UNTIL(event == AVAILABLE);</span>00073 <span class="comment"> consume();</span>00074 <span class="comment"> PT_WAIT_UNTIL(event == CONSUMED);</span>00075 <span class="comment"> acknowledge_consumed();</span>00076 <span class="comment"> }</span>00077 <span class="comment"> PT_END(p);</span>00078 <span class="comment"> }</span>00079 <span class="comment"> \endcode</span>00080 <span class="comment"> *</span>00081 <span class="comment"> * \param name_args The name and arguments of the C function</span>00082 <span class="comment"> * implementing the protothread.</span>00083 <span class="comment"> *</span>00084 <span class="comment"> * \hideinitializer</span>00085 <span class="comment"> */</span><a name="l00086"></a><a class="code" href="a00012.html#ga2">00086</a> <span class="preprocessor">#define PT_THREAD(name_args) char name_args</span>00087 <span class="preprocessor"></span><span class="comment"></span>00088 <span class="comment">/**</span>00089 <span class="comment"> * Initialize a protothread.</span>00090 <span class="comment"> *</span>00091 <span class="comment"> * Initializes a protothread. Initialization must be done prior to</span>00092 <span class="comment"> * starting to execute the protothread.</span>00093 <span class="comment"> *</span>00094 <span class="comment"> * \param pt A pointer to the protothread control structure.</span>00095 <span class="comment"> *</span>00096 <span class="comment"> * Example:</span>00097 <span class="comment"> *</span>00098 <span class="comment"> \code</span>00099 <span class="comment"> void main(void) {</span>00100 <span class="comment"> struct pt p;</span>00101 <span class="comment"> int event;</span>00102 <span class="comment"> </span>00103 <span class="comment"> PT_INIT(&p);</span>00104 <span class="comment"> while(PT_SCHEDULE(consumer(&p, event))) {</span>00105 <span class="comment"> event = get_event();</span>00106 <span class="comment"> }</span>00107 <span class="comment"> }</span>00108 <span class="comment"> \endcode</span>00109 <span class="comment"> *</span>00110 <span class="comment"> * \hideinitializer</span>00111 <span class="comment"> */</span><a name="l00112"></a><a class="code" href="a00012.html#ga3">00112</a> <span class="preprocessor">#define PT_INIT(pt) \</span>00113 <span class="preprocessor"> LC_INIT((pt)->lc)</span>00114 <span class="preprocessor"></span><span class="comment"></span>00115 <span class="comment">/**</span>00116 <span class="comment"> * Declare the start of a protothread inside the C function</span>00117 <span class="comment"> * implementing the protothread.</span>00118 <span class="comment"> *</span>00119 <span class="comment"> * This macro is used to declare the starting point of a</span>00120 <span class="comment"> * protothread. It should be placed at the start of the function in</span>00121 <span class="comment"> * which the protothread runs. All C statements above the PT_BEGIN()</span>00122 <span class="comment"> * invokation will be executed each time the protothread is scheduled.</span>00123 <span class="comment"> *</span>00124 <span class="comment"> * \param pt A pointer to the protothread control structure.</span>00125 <span class="comment"> *</span>00126 <span class="comment"> * Example:</span>00127 <span class="comment"> *</span>00128 <span class="comment"> \code</span>00129 <span class="comment"> PT_THREAD(producer(struct pt *p, int event)) {</span>00130 <span class="comment"> PT_BEGIN(p);</span>00131 <span class="comment"> while(1) {</span>00132 <span class="comment"> PT_WAIT_UNTIL(event == CONSUMED || event == DROPPED);</span>00133 <span class="comment"> produce();</span>00134 <span class="comment"> PT_WAIT_UNTIL(event == PRODUCED);</span>00135 <span class="comment"> }</span>00136 <span class="comment"> </span>00137 <span class="comment"> PT_END(p);</span>00138 <span class="comment"> }</span>00139 <span class="comment"> \endcode</span>00140 <span class="comment"> *</span>00141 <span class="comment"> * \hideinitializer</span>00142 <span class="comment"> */</span><a name="l00143"></a><a class="code" href="a00012.html#ga4">00143</a> <span class="preprocessor">#define PT_BEGIN(pt) LC_RESUME((pt)->lc)</span>00144 <span class="preprocessor"></span><span class="comment">/*\</span>00145 <span class="comment"> do { \</span>00146 <span class="comment"> if((pt)->lc != LC_NULL) { \</span>00147 <span class="comment"> LC_RESUME((pt)->lc); \</span>00148 <span class="comment"> } \</span>00149 <span class="comment"> } while(0)*/</span>00150 <span class="comment"></span>00151 <span class="comment">/**</span>00152 <span class="comment"> * Block and wait until condition is true.</span>00153 <span class="comment"> *</span>00154 <span class="comment"> * This macro blocks the protothread until the specified condition is</span>00155 <span class="comment"> * true.</span>00156 <span class="comment"> *</span>00157 <span class="comment"> * \param pt A pointer to the protothread control structure.</span>00158 <span class="comment"> * \param condition The condition.</span>00159 <span class="comment"> *</span>00160 <span class="comment"> * Example:</span>00161 <span class="comment"> \code</span>00162 <span class="comment"> PT_THREAD(seconds(struct pt *p)) {</span>00163 <span class="comment"> PT_BEGIN(p);</span>00164 <span class="comment"></span>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -