web/docs/structasync__context__type.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_context_type 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__context__type.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_context_type 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>Implementation of 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> type, providing methods common to that type.
 112  <a href="structasync__context__type.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 <table class="memberdecls">
 116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
 117 Data Fields</h2></td></tr>
 118 <tr class="memitem:a57eeceade47db04df7464a34f42e3d70"><td class="memItemLeft" align="right" valign="top"><a id="a57eeceade47db04df7464a34f42e3d70" name="a57eeceade47db04df7464a34f42e3d70"></a>
 119 uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
 120 <tr class="separator:a57eeceade47db04df7464a34f42e3d70"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:aa0dcb9f332817e93824e8ea8d8f35fdd"><td class="memItemLeft" align="right" valign="top"><a id="aa0dcb9f332817e93824e8ea8d8f35fdd" name="aa0dcb9f332817e93824e8ea8d8f35fdd"></a>
 122 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>acquire_lock_blocking</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self)</td></tr>
 123 <tr class="separator:aa0dcb9f332817e93824e8ea8d8f35fdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <tr class="memitem:a57bc488e9ae86f5c1d33786c3537345c"><td class="memItemLeft" align="right" valign="top"><a id="a57bc488e9ae86f5c1d33786c3537345c" name="a57bc488e9ae86f5c1d33786c3537345c"></a>
 125 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>release_lock</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self)</td></tr>
 126 <tr class="separator:a57bc488e9ae86f5c1d33786c3537345c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:acc76ca7bf22863c7306bbfd5383a87bd"><td class="memItemLeft" align="right" valign="top"><a id="acc76ca7bf22863c7306bbfd5383a87bd" name="acc76ca7bf22863c7306bbfd5383a87bd"></a>
 128 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>lock_check</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self)</td></tr>
 129 <tr class="separator:acc76ca7bf22863c7306bbfd5383a87bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="memitem:a8895554b164707c7839076e4c8111134"><td class="memItemLeft" align="right" valign="top"><a id="a8895554b164707c7839076e4c8111134" name="a8895554b164707c7839076e4c8111134"></a>
 131 uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><b>execute_sync</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *context, uint32_t(*func)(void *param), void *param)</td></tr>
 132 <tr class="separator:a8895554b164707c7839076e4c8111134"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:a0be376cf359ecca14afe5776d405fbf7"><td class="memItemLeft" align="right" valign="top"><a id="a0be376cf359ecca14afe5776d405fbf7" name="a0be376cf359ecca14afe5776d405fbf7"></a>
 134 bool(*&#160;</td><td class="memItemRight" valign="bottom"><b>add_at_time_worker</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self, <a class="el" href="group__pico__async__context.html#ga74aa4914d98b190d2d4d84d7ff6b469e">async_at_time_worker_t</a> *worker)</td></tr>
 135 <tr class="separator:a0be376cf359ecca14afe5776d405fbf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:a1707b00cab07cdc868a89aed69e213ac"><td class="memItemLeft" align="right" valign="top"><a id="a1707b00cab07cdc868a89aed69e213ac" name="a1707b00cab07cdc868a89aed69e213ac"></a>
 137 bool(*&#160;</td><td class="memItemRight" valign="bottom"><b>remove_at_time_worker</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self, <a class="el" href="group__pico__async__context.html#ga74aa4914d98b190d2d4d84d7ff6b469e">async_at_time_worker_t</a> *worker)</td></tr>
 138 <tr class="separator:a1707b00cab07cdc868a89aed69e213ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a5823937a3542993c31ca0bf2d069f2ee"><td class="memItemLeft" align="right" valign="top"><a id="a5823937a3542993c31ca0bf2d069f2ee" name="a5823937a3542993c31ca0bf2d069f2ee"></a>
 140 bool(*&#160;</td><td class="memItemRight" valign="bottom"><b>add_when_pending_worker</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self, <a class="el" href="group__pico__async__context.html#ga975e8fa20352873b7ac76b06a497eb2b">async_when_pending_worker_t</a> *worker)</td></tr>
 141 <tr class="separator:a5823937a3542993c31ca0bf2d069f2ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:a9b31890e1b2b8a8b53aaebba8a1ac168"><td class="memItemLeft" align="right" valign="top"><a id="a9b31890e1b2b8a8b53aaebba8a1ac168" name="a9b31890e1b2b8a8b53aaebba8a1ac168"></a>
 143 bool(*&#160;</td><td class="memItemRight" valign="bottom"><b>remove_when_pending_worker</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self, <a class="el" href="group__pico__async__context.html#ga975e8fa20352873b7ac76b06a497eb2b">async_when_pending_worker_t</a> *worker)</td></tr>
 144 <tr class="separator:a9b31890e1b2b8a8b53aaebba8a1ac168"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:adea5bac06b8c7672cd069bfbeb5266bb"><td class="memItemLeft" align="right" valign="top"><a id="adea5bac06b8c7672cd069bfbeb5266bb" name="adea5bac06b8c7672cd069bfbeb5266bb"></a>
 146 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>set_work_pending</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self, <a class="el" href="group__pico__async__context.html#ga975e8fa20352873b7ac76b06a497eb2b">async_when_pending_worker_t</a> *worker)</td></tr>
 147 <tr class="separator:adea5bac06b8c7672cd069bfbeb5266bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:a1144875e55a01edca14daaf483e8242f"><td class="memItemLeft" align="right" valign="top"><a id="a1144875e55a01edca14daaf483e8242f" name="a1144875e55a01edca14daaf483e8242f"></a>
 149 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>poll</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self)</td></tr>
 150 <tr class="separator:a1144875e55a01edca14daaf483e8242f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:a7feba52874fa7a711bf0915cbf690948"><td class="memItemLeft" align="right" valign="top"><a id="a7feba52874fa7a711bf0915cbf690948" name="a7feba52874fa7a711bf0915cbf690948"></a>
 152 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>wait_until</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self, <a class="el" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> until)</td></tr>
 153 <tr class="separator:a7feba52874fa7a711bf0915cbf690948"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:a453f9d45470c4cfe23ccccae1b020ef0"><td class="memItemLeft" align="right" valign="top"><a id="a453f9d45470c4cfe23ccccae1b020ef0" name="a453f9d45470c4cfe23ccccae1b020ef0"></a>
 155 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>wait_for_work_until</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self, <a class="el" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> until)</td></tr>
 156 <tr class="separator:a453f9d45470c4cfe23ccccae1b020ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:a2c91ce8adb366019a575da1683094864"><td class="memItemLeft" align="right" valign="top"><a id="a2c91ce8adb366019a575da1683094864" name="a2c91ce8adb366019a575da1683094864"></a>
 158 void(*&#160;</td><td class="memItemRight" valign="bottom"><b>deinit</b> )(<a class="el" href="structasync__context.html">async_context_t</a> *self)</td></tr>
 159 <tr class="separator:a2c91ce8adb366019a575da1683094864"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 </table>
 161 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 162 <div class="textblock"><p >Implementation of 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> type, providing methods common to that type. </p>
 163 </div><hr/>The documentation for this struct was generated from the following file:<ul>
 164 <li>include/pico/<a class="el" href="async__context_8h_source.html">async_context.h</a></li>
 165 </ul>
 166 </div><!-- contents -->
 167 </div><!-- doc-content -->
 168
 169         <script src="main.js"></script>
 170 </body>
 171 </html>