Home Explore Help
Register Sign In
embedded
/
owner-nrf52sdk
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: c1d97a59f9
Branches Tags
owner-nrf52sdk
/
nRF5_SDK_15.2.0
/
external
/
protothreads
/
pt-1.4
/
doc
/
html
/
a00013.html

a00013.html 9.3 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    3. 

  3. <title>The Protothreads Library 1.4: pt.h File Reference</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.4.6 -->
    8. 

  8. <div class="tabs">
    9. 

  9.   <ul>
    10. 

  10.     <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    11. 

  11.     <li><a href="modules.html"><span>Modules</span></a></li>
    12. 

  12.     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    13. 

  13.     <li id="current"><a href="files.html"><span>Files</span></a></li>
    14. 

  14.   </ul></div>
    15. 

  15. <div class="tabs">
    16. 

  16.   <ul>
    17. 

  17.     <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    18. 

  18.     <li><a href="globals.html"><span>Globals</span></a></li>
    19. 

  19.   </ul></div>
    20. 

  20. <h1>pt.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
    21. 

  21. Protothreads implementation. 
    22. 

  22. <p>
    23. 

  23. <dl compact><dt><b>Author:</b></dt><dd>Adam Dunkels &lt;<a href="mailto:adam@sics.se">adam@sics.se</a>&gt; </dd></dl>
    24. 

  24. 

  25. <p>
    26. 

  26. Definition in file <a class="el" href="a00022.html">pt.h</a>.
    27. 

  27. <p>
    28. 

  28. <code>#include &quot;<a class="el" href="a00020.html">lc.h</a>&quot;</code><br>
    29. 

  29. 

  30. <p>
    31. 

  31. <a href="a00022.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
    32. 

  32. <tr><td></td></tr>
    33. 

  33. <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
    34. 

  34. <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html">pt</a></td></tr>
    35. 

  35. 

  36. <tr><td colspan="2"><br><h2>Initialization</h2></td></tr>
    37. 

  37. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#ge6bae7dc0225468c8a5ac269df549892">PT_INIT</a>(<a class="el" href="a00005.html">pt</a>)</td></tr>
    38. 

  38. 

  39. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize a protothread.  <a href="a00014.html#ge6bae7dc0225468c8a5ac269df549892"></a><br></td></tr>
    40. 

  40. <tr><td colspan="2"><br><h2>Declaration and definition</h2></td></tr>
    41. 

  41. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g3d4c8bd4aada659eb34f5d2ffd3e7901">PT_THREAD</a>(name_args)</td></tr>
    42. 

  42. 

  43. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Declaration of a protothread.  <a href="a00014.html#g3d4c8bd4aada659eb34f5d2ffd3e7901"></a><br></td></tr>
    44. 

  44. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g2ffbb9e554e08a343ae2f9de4bedfdfc">PT_BEGIN</a>(<a class="el" href="a00005.html">pt</a>)</td></tr>
    45. 

  45. 

  46. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Declare the start of a protothread inside the C function implementing the protothread.  <a href="a00014.html#g2ffbb9e554e08a343ae2f9de4bedfdfc"></a><br></td></tr>
    47. 

  47. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g7b04a0035bef29d905496c23bae066d2">PT_END</a>(<a class="el" href="a00005.html">pt</a>)</td></tr>
    48. 

  48. 

  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Declare the end of a protothread.  <a href="a00014.html#g7b04a0035bef29d905496c23bae066d2"></a><br></td></tr>
    50. 

  50. <tr><td colspan="2"><br><h2>Blocked wait</h2></td></tr>
    51. 

  51. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g99e43010ec61327164466aa2d902de45">PT_WAIT_UNTIL</a>(<a class="el" href="a00005.html">pt</a>, condition)</td></tr>
    52. 

  52. 

  53. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Block and wait until condition is true.  <a href="a00014.html#g99e43010ec61327164466aa2d902de45"></a><br></td></tr>
    54. 

  54. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#gad14bbbf092b90aa0a5a4f9169504a8d">PT_WAIT_WHILE</a>(<a class="el" href="a00005.html">pt</a>, cond)</td></tr>
    55. 

  55. 

  56. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Block and wait while condition is true.  <a href="a00014.html#gad14bbbf092b90aa0a5a4f9169504a8d"></a><br></td></tr>
    57. 

  57. <tr><td colspan="2"><br><h2>Hierarchical protothreads</h2></td></tr>
    58. 

  58. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g2f8f70c30b9ee08a103fbd69a4365c4c">PT_WAIT_THREAD</a>(<a class="el" href="a00005.html">pt</a>, thread)</td></tr>
    59. 

  59. 

  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Block and wait until a child protothread completes.  <a href="a00014.html#g2f8f70c30b9ee08a103fbd69a4365c4c"></a><br></td></tr>
    61. 

  61. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g9e97a0b4d5cc7764d8e19758f5da53ae">PT_SPAWN</a>(<a class="el" href="a00005.html">pt</a>, child, thread)</td></tr>
    62. 

  62. 

  63. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Spawn a child protothread and wait until it exits.  <a href="a00014.html#g9e97a0b4d5cc7764d8e19758f5da53ae"></a><br></td></tr>
    64. 

  64. <tr><td colspan="2"><br><h2>Exiting and restarting</h2></td></tr>
    65. 

  65. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#gcd3ac045f0a4ae63412e3b3d8780e8ab">PT_RESTART</a>(<a class="el" href="a00005.html">pt</a>)</td></tr>
    66. 

  66. 

  67. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Restart the protothread.  <a href="a00014.html#gcd3ac045f0a4ae63412e3b3d8780e8ab"></a><br></td></tr>
    68. 

  68. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g905451249dca72ce0385bf2a9ff178ee">PT_EXIT</a>(<a class="el" href="a00005.html">pt</a>)</td></tr>
    69. 

  69. 

  70. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Exit the protothread.  <a href="a00014.html#g905451249dca72ce0385bf2a9ff178ee"></a><br></td></tr>
    71. 

  71. <tr><td colspan="2"><br><h2>Calling a protothread</h2></td></tr>
    72. 

  72. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#gfa82b860a64b67d25ab3abc21811896f">PT_SCHEDULE</a>(f)</td></tr>
    73. 

  73. 

  74. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Schedule a protothread.  <a href="a00014.html#gfa82b860a64b67d25ab3abc21811896f"></a><br></td></tr>
    75. 

  75. <tr><td colspan="2"><br><h2>Yielding from a protothread</h2></td></tr>
    76. 

  76. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g155cba6121323726d02c00284428fed6">PT_YIELD</a>(<a class="el" href="a00005.html">pt</a>)</td></tr>
    77. 

  77. 

  78. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Yield from the current protothread.  <a href="a00014.html#g155cba6121323726d02c00284428fed6"></a><br></td></tr>
    79. 

  79. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#ge3c821e3a388615528efda9d23c7d115">PT_YIELD_UNTIL</a>(<a class="el" href="a00005.html">pt</a>, cond)</td></tr>
    80. 

  80. 

  81. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Yield from the protothread until a condition occurs.  <a href="a00014.html#ge3c821e3a388615528efda9d23c7d115"></a><br></td></tr>
    82. 

  82. <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
    83. 

  83. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b5319b5b65761a845fcd1500fde4cdc"></a><!-- doxytag: member="pt.h::PT_WAITING" ref="g7b5319b5b65761a845fcd1500fde4cdc" args="" -->
    84. 

  84. #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g7b5319b5b65761a845fcd1500fde4cdc">PT_WAITING</a>&nbsp;&nbsp;&nbsp;0</td></tr>
    85. 

  85. 

  86. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge469332907e0617d72d5e2dd4297119d"></a><!-- doxytag: member="pt.h::PT_YIELDED" ref="ge469332907e0617d72d5e2dd4297119d" args="" -->
    87. 

  87. #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#ge469332907e0617d72d5e2dd4297119d">PT_YIELDED</a>&nbsp;&nbsp;&nbsp;1</td></tr>
    88. 

  88. 

  89. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcfae9053e5c107a1aed6b228c917d2ea"></a><!-- doxytag: member="pt.h::PT_EXITED" ref="gcfae9053e5c107a1aed6b228c917d2ea" args="" -->
    90. 

  90. #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#gcfae9053e5c107a1aed6b228c917d2ea">PT_EXITED</a>&nbsp;&nbsp;&nbsp;2</td></tr>
    91. 

  91. 

  92. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9ff1e8936a8a26bff54c05f8a989b93b"></a><!-- doxytag: member="pt.h::PT_ENDED" ref="g9ff1e8936a8a26bff54c05f8a989b93b" args="" -->
    93. 

  93. #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#g9ff1e8936a8a26bff54c05f8a989b93b">PT_ENDED</a>&nbsp;&nbsp;&nbsp;3</td></tr>
    94. 

  94. 

  95. </table>
    96. 

  96. <hr size="1"><address style="align: right;"><small>Generated on Mon Oct 2 10:06:29 2006 for The Protothreads Library 1.4 by&nbsp;
    97. 

  97. <a href="http://www.doxygen.org/index.html">
    98. 

  98. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
    99. 

  99. </body>
    100. 

  100. </html>
    101.