1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>uIP 1.0: uip/pt.h File Reference</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<!-- Generated by Doxygen 1.4.6 --> 8<div class="tabs"> 9 <ul> 10 <li><a href="main.html"><span>Main Page</span></a></li> 11 <li><a href="modules.html"><span>Modules</span></a></li> 12 <li><a href="classes.html"><span>Data Structures</span></a></li> 13 <li id="current"><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<div class="tabs"> 17 <ul> 18 <li><a href="files.html"><span>File List</span></a></li> 19 <li><a href="globals.html"><span>Globals</span></a></li> 20 </ul></div> 21<h1>uip/pt.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> 22Protothreads implementation. 23<p> 24<dl compact><dt><b>Author:</b></dt><dd>Adam Dunkels <<a href="mailto:[email protected]">[email protected]</a>> </dd></dl> 25 26<p> 27Definition in file <a class="el" href="a00194.html">pt.h</a>. 28<p> 29<code>#include "<a class="el" href="a00191.html">lc.h</a>"</code><br> 30 31<p> 32<a href="a00194.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> 33<tr><td></td></tr> 34<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> 35<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="a00084.html">pt</a></td></tr> 36 37<tr><td colspan="2"><br><h2>Initialization</h2></td></tr> 38<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#ge6bae7dc0225468c8a5ac269df549892">PT_INIT</a>(<a class="el" href="a00084.html">pt</a>)</td></tr> 39 40<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a protothread. <a href="a00142.html#ge6bae7dc0225468c8a5ac269df549892"></a><br></td></tr> 41<tr><td colspan="2"><br><h2>Declaration and definition</h2></td></tr> 42<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">PT_THREAD</a>(name_args)</td></tr> 43 44<tr><td class="mdescLeft"> </td><td class="mdescRight">Declaration of a protothread. <a href="a00142.html#g3d4c8bd4aada659eb34f5d2ffd3e7901"></a><br></td></tr> 45<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g2ffbb9e554e08a343ae2f9de4bedfdfc">PT_BEGIN</a>(<a class="el" href="a00084.html">pt</a>)</td></tr> 46 47<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare the start of a protothread inside the C function implementing the protothread. <a href="a00142.html#g2ffbb9e554e08a343ae2f9de4bedfdfc"></a><br></td></tr> 48<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g7b04a0035bef29d905496c23bae066d2">PT_END</a>(<a class="el" href="a00084.html">pt</a>)</td></tr> 49 50<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare the end of a protothread. <a href="a00142.html#g7b04a0035bef29d905496c23bae066d2"></a><br></td></tr> 51<tr><td colspan="2"><br><h2>Blocked wait</h2></td></tr> 52<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g99e43010ec61327164466aa2d902de45">PT_WAIT_UNTIL</a>(<a class="el" href="a00084.html">pt</a>, condition)</td></tr> 53 54<tr><td class="mdescLeft"> </td><td class="mdescRight">Block and wait until condition is true. <a href="a00142.html#g99e43010ec61327164466aa2d902de45"></a><br></td></tr> 55<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#gad14bbbf092b90aa0a5a4f9169504a8d">PT_WAIT_WHILE</a>(<a class="el" href="a00084.html">pt</a>, cond)</td></tr> 56 57<tr><td class="mdescLeft"> </td><td class="mdescRight">Block and wait while condition is true. <a href="a00142.html#gad14bbbf092b90aa0a5a4f9169504a8d"></a><br></td></tr> 58<tr><td colspan="2"><br><h2>Hierarchical protothreads</h2></td></tr> 59<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g2f8f70c30b9ee08a103fbd69a4365c4c">PT_WAIT_THREAD</a>(<a class="el" href="a00084.html">pt</a>, thread)</td></tr> 60 61<tr><td class="mdescLeft"> </td><td class="mdescRight">Block and wait until a child protothread completes. <a href="a00142.html#g2f8f70c30b9ee08a103fbd69a4365c4c"></a><br></td></tr> 62<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g9e97a0b4d5cc7764d8e19758f5da53ae">PT_SPAWN</a>(<a class="el" href="a00084.html">pt</a>, child, thread)</td></tr> 63 64<tr><td class="mdescLeft"> </td><td class="mdescRight">Spawn a child protothread and wait until it exits. <a href="a00142.html#g9e97a0b4d5cc7764d8e19758f5da53ae"></a><br></td></tr> 65<tr><td colspan="2"><br><h2>Exiting and restarting</h2></td></tr> 66<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#gcd3ac045f0a4ae63412e3b3d8780e8ab">PT_RESTART</a>(<a class="el" href="a00084.html">pt</a>)</td></tr> 67 68<tr><td class="mdescLeft"> </td><td class="mdescRight">Restart the protothread. <a href="a00142.html#gcd3ac045f0a4ae63412e3b3d8780e8ab"></a><br></td></tr> 69<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g905451249dca72ce0385bf2a9ff178ee">PT_EXIT</a>(<a class="el" href="a00084.html">pt</a>)</td></tr> 70 71<tr><td class="mdescLeft"> </td><td class="mdescRight">Exit the protothread. <a href="a00142.html#g905451249dca72ce0385bf2a9ff178ee"></a><br></td></tr> 72<tr><td colspan="2"><br><h2>Calling a protothread</h2></td></tr> 73<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#gfa82b860a64b67d25ab3abc21811896f">PT_SCHEDULE</a>(f)</td></tr> 74 75<tr><td class="mdescLeft"> </td><td class="mdescRight">Schedule a protothread. <a href="a00142.html#gfa82b860a64b67d25ab3abc21811896f"></a><br></td></tr> 76<tr><td colspan="2"><br><h2>Yielding from a protothread</h2></td></tr> 77<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g155cba6121323726d02c00284428fed6">PT_YIELD</a>(<a class="el" href="a00084.html">pt</a>)</td></tr> 78 79<tr><td class="mdescLeft"> </td><td class="mdescRight">Yield from the current protothread. <a href="a00142.html#g155cba6121323726d02c00284428fed6"></a><br></td></tr> 80<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#ge3c821e3a388615528efda9d23c7d115">PT_YIELD_UNTIL</a>(<a class="el" href="a00084.html">pt</a>, cond)</td></tr> 81 82<tr><td class="mdescLeft"> </td><td class="mdescRight">Yield from the protothread until a condition occurs. <a href="a00142.html#ge3c821e3a388615528efda9d23c7d115"></a><br></td></tr> 83<tr><td colspan="2"><br><h2>Defines</h2></td></tr> 84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b5319b5b65761a845fcd1500fde4cdc"></a><!-- doxytag: member="pt.h::PT_WAITING" ref="g7b5319b5b65761a845fcd1500fde4cdc" args="" --> 85#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g7b5319b5b65761a845fcd1500fde4cdc">PT_WAITING</a> 0</td></tr> 86 87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcfae9053e5c107a1aed6b228c917d2ea"></a><!-- doxytag: member="pt.h::PT_EXITED" ref="gcfae9053e5c107a1aed6b228c917d2ea" args="" --> 88#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#gcfae9053e5c107a1aed6b228c917d2ea">PT_EXITED</a> 1</td></tr> 89 90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9ff1e8936a8a26bff54c05f8a989b93b"></a><!-- doxytag: member="pt.h::PT_ENDED" ref="g9ff1e8936a8a26bff54c05f8a989b93b" args="" --> 91#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#g9ff1e8936a8a26bff54c05f8a989b93b">PT_ENDED</a> 2</td></tr> 92 93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge469332907e0617d72d5e2dd4297119d"></a><!-- doxytag: member="pt.h::PT_YIELDED" ref="ge469332907e0617d72d5e2dd4297119d" args="" --> 94#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#ge469332907e0617d72d5e2dd4297119d">PT_YIELDED</a> 3</td></tr> 95 96</table> 97<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by 98<a href="http://www.doxygen.org/index.html"> 99<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 100</body> 101</html> 102
