web/docs/structasync__work__on__timeout.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: async_work_on_timeout Struct Reference</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('structasync__work__on__timeout.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#pub-attribs">Data Fields</a>  </div>
 107   <div class="headertitle"><div class="title">async_work_on_timeout Struct Reference<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a> &raquo; <a class="el" href="group__pico__async__context.html">pico_async_context</a></div></div></div>
 108 </div><!--header-->
 109 <div class="contents">
 110
 111 <p>A "timeout" instance used by an <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>.
 112  <a href="structasync__work__on__timeout.html#details">More...</a></p>
 113
 114 <p><code>#include &lt;<a class="el" href="async__context_8h_source.html">async_context.h</a>&gt;</code></p>
 115 <div class="dynheader">
 116 Collaboration diagram for async_work_on_timeout:</div>
 117 <div class="dyncontent">
 118 <div class="center"><img src="structasync__work__on__timeout__coll__graph.png" border="0" usemap="#aasync__work__on__timeout_coll__map" alt="Collaboration graph"/></div>
 119 <map name="aasync__work__on__timeout_coll__map" id="aasync__work__on__timeout_coll__map">
 120 <area shape="rect" title="A &quot;timeout&quot; instance used by an async_context." alt="" coords="5,5,185,32"/>
 121 </map>
 122 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
 123 <table class="memberdecls">
 124 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
 125 Data Fields</h2></td></tr>
 126 <tr class="memitem:a0d624915407b8a4c38d0bc8b2e097729"><td class="memItemLeft" align="right" valign="top"><a id="a0d624915407b8a4c38d0bc8b2e097729" name="a0d624915407b8a4c38d0bc8b2e097729"></a>
 127 struct <a class="el" href="structasync__work__on__timeout.html">async_work_on_timeout</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>next</b></td></tr>
 128 <tr class="memdesc:a0d624915407b8a4c38d0bc8b2e097729"><td class="mdescLeft">&#160;</td><td class="mdescRight">private link list pointer <br /></td></tr>
 129 <tr class="separator:a0d624915407b8a4c38d0bc8b2e097729"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="memitem:a01235aef0d013ca28c820df4809c505b"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structasync__work__on__timeout.html#a01235aef0d013ca28c820df4809c505b">do_work</a> )(<a class="el" href="structasync__context.html">async_context_t</a> *context, struct <a class="el" href="structasync__work__on__timeout.html">async_work_on_timeout</a> *timeout)</td></tr>
 131 <tr class="memdesc:a01235aef0d013ca28c820df4809c505b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method called when the timeout is reached; may not be NULL.  <a href="structasync__work__on__timeout.html#a01235aef0d013ca28c820df4809c505b">More...</a><br /></td></tr>
 132 <tr class="separator:a01235aef0d013ca28c820df4809c505b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:a695beb1e493cb6c2b15f0907e9a2cfb4"><td class="memItemLeft" align="right" valign="top"><a id="a695beb1e493cb6c2b15f0907e9a2cfb4" name="a695beb1e493cb6c2b15f0907e9a2cfb4"></a>
 134 <a class="el" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>next_time</b></td></tr>
 135 <tr class="memdesc:a695beb1e493cb6c2b15f0907e9a2cfb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The next timeout time; this should only be modified during the above methods or via <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a> methods. <br /></td></tr>
 136 <tr class="separator:a695beb1e493cb6c2b15f0907e9a2cfb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:aaa3132dfb1f9a29b4e3feae105da4b59"><td class="memItemLeft" align="right" valign="top"><a id="aaa3132dfb1f9a29b4e3feae105da4b59" name="aaa3132dfb1f9a29b4e3feae105da4b59"></a>
 138 void *&#160;</td><td class="memItemRight" valign="bottom"><b>user_data</b></td></tr>
 139 <tr class="memdesc:aaa3132dfb1f9a29b4e3feae105da4b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data associated with the timeout instance. <br /></td></tr>
 140 <tr class="separator:aaa3132dfb1f9a29b4e3feae105da4b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 </table>
 142 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 143 <div class="textblock"><p >A "timeout" instance used by an <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>. </p>
 144 <p >A "timeout" represents some future action that must be taken at a specific time. Its methods are called from the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a> under lock at the given time</p>
 145 <dl class="section see"><dt>See also</dt><dd>async_context_add_worker_at </dd>
 146 <dd>
 147 async_context_add_worker_in_ms </dd></dl>
 148 </div><h2 class="groupheader">Field Documentation</h2>
 149 <a id="a01235aef0d013ca28c820df4809c505b" name="a01235aef0d013ca28c820df4809c505b"></a>
 150 <h2 class="memtitle"><span class="permalink"><a href="#a01235aef0d013ca28c820df4809c505b">&#9670;&nbsp;</a></span>do_work</h2>
 151
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname">void(* async_work_on_timeout::do_work) (<a class="el" href="structasync__context.html">async_context_t</a> *context, struct <a class="el" href="structasync__work__on__timeout.html">async_work_on_timeout</a> *timeout)</td>
 157         </tr>
 158       </table>
 159 </div><div class="memdoc">
 160
 161 <p>Method called when the timeout is reached; may not be NULL. </p>
 162 <p >Note, that when this method is called, the timeout has been removed from the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>, so if you want the timeout to repeat, you should re-add it during this callback </p><dl class="params"><dt>Parameters</dt><dd>
 163   <table class="params">
 164     <tr><td class="paramname">context</td><td></td></tr>
 165     <tr><td class="paramname">timeout</td><td></td></tr>
 166   </table>
 167   </dd>
 168 </dl>
 169
 170 </div>
 171 </div>
 172 <hr/>The documentation for this struct was generated from the following file:<ul>
 173 <li>include/pico/<a class="el" href="async__context_8h_source.html">async_context.h</a></li>
 174 </ul>
 175 </div><!-- contents -->
 176 </div><!-- doc-content -->
 177
 178         <script src="main.js"></script>
 179 </body>
 180 </html>