web/docs/group__async__context__poll.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_poll</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('group__async__context__poll.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="#func-members">Functions</a>  </div>
 107   <div class="headertitle"><div class="title">async_context_poll<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 class="el" href="structasync__context__poll.html">async_context_poll</a> provides an implementation of <a class="el" href="structasync__context.html">async_context</a> that is intended for use with a simple polling loop on one core. It is not thread safe.
 112 <a href="#details">More...</a></p>
 113 <table class="memberdecls">
 114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 115 Functions</h2></td></tr>
 116 <tr class="memitem:ga4ee772d4efa94ec03e2b2ae2f775837d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__async__context__poll.html#ga4ee772d4efa94ec03e2b2ae2f775837d">async_context_poll_init_with_defaults</a> (<a class="el" href="structasync__context__poll.html">async_context_poll_t</a> *self)</td></tr>
 117 <tr class="memdesc:ga4ee772d4efa94ec03e2b2ae2f775837d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize an <a class="el" href="structasync__context__poll.html">async_context_poll</a> instance with default values.  <a href="group__async__context__poll.html#ga4ee772d4efa94ec03e2b2ae2f775837d">More...</a><br /></td></tr>
 118 <tr class="separator:ga4ee772d4efa94ec03e2b2ae2f775837d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 </table>
 120 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 121 <p ><a class="el" href="structasync__context__poll.html">async_context_poll</a> provides an implementation of <a class="el" href="structasync__context.html">async_context</a> that is intended for use with a simple polling loop on one core. It is not thread safe. </p>
 122 <p >The <a class="el" href="group__pico__async__context.html#gafdb322c3f1043265624988215d3a8df9">async_context_poll()</a> method must be called periodically to handle asynchronous work that may now be pending. <a class="el" href="group__pico__async__context.html#ga6207f562c0b69c7a75cd81a783eb1055">async_context_wait_for_work_until()</a> may be used to block a polling loop until there is work to do, and prevent tight spinning. </p>
 123 <h2 class="groupheader">Function Documentation</h2>
 124 <a id="ga4ee772d4efa94ec03e2b2ae2f775837d" name="ga4ee772d4efa94ec03e2b2ae2f775837d"></a>
 125 <h2 class="memtitle"><span class="permalink"><a href="#ga4ee772d4efa94ec03e2b2ae2f775837d">&#9670;&nbsp;</a></span>async_context_poll_init_with_defaults()</h2>
 126
 127 <div class="memitem">
 128 <div class="memproto">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname">bool async_context_poll_init_with_defaults </td>
 132           <td>(</td>
 133           <td class="paramtype"><a class="el" href="structasync__context__poll.html">async_context_poll_t</a> *&#160;</td>
 134           <td class="paramname"><em>self</em></td><td>)</td>
 135           <td></td>
 136         </tr>
 137       </table>
 138 </div><div class="memdoc">
 139
 140 <p>Initialize an <a class="el" href="structasync__context__poll.html">async_context_poll</a> instance with default values. </p>
 141 <p >If this method succeeds (returns true), then 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> is available for use and can be de-initialized by calling <a class="el" href="group__pico__async__context.html#ga66d09e106e04d70971d4fb6f09d5d949" title="End async_context processing, and free any resources.">async_context_deinit()</a>.</p>
 142 <dl class="params"><dt>Parameters</dt><dd>
 143   <table class="params">
 144     <tr><td class="paramname">self</td><td>a pointer to <a class="el" href="structasync__context__poll.html">async_context_poll</a> structure to initialize </td></tr>
 145   </table>
 146   </dd>
 147 </dl>
 148 <dl class="section return"><dt>Returns</dt><dd>true if initialization is successful, false otherwise </dd></dl>
 149
 150 </div>
 151 </div>
 152 </div><!-- contents -->
 153 </div><!-- doc-content -->
 154
 155         <script src="main.js"></script>
 156 </body>
 157 </html>