Skip to content

Commit ebca8af

Browse files
kammcelibhal-bot
andauthored
Add async_context main API documentation (#81)
Co-authored-by: libhal-bot <libhal-bot@users.noreply.github.com>
1 parent 96d89f8 commit ebca8af

8 files changed

Lines changed: 158 additions & 71 deletions

File tree

27.5 KB
Binary file not shown.
11.9 KB
Binary file not shown.

async_context/main/_sources/api/async_context.md.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Defined in namespace `async::v0`
99
```{doxygenclass} v0::context
1010
```
1111

12-
## async::basic_context
12+
## async::inplace_context
1313

1414
Defined in namespace `async::v0`
1515

async_context/main/api/async_context.html

Lines changed: 131 additions & 52 deletions
Large diffs are not rendered by default.

async_context/main/genindex.html

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -368,8 +368,6 @@ <h1 id="index">Index</h1>
368368
<h2 id="V">V</h2>
369369
<table style="width: 100%" class="indextable genindextable"><tr>
370370
<td style="width: 33%; vertical-align: top;"><ul>
371-
<li><a href="api/async_context.html#_CPPv4I_6size_tEN2v013basic_contextE">v0::basic_context (C++ class)</a>
372-
</li>
373371
<li><a href="api/async_context.html#_CPPv4N2v010blocked_byE">v0::blocked_by (C++ enum)</a>
374372
</li>
375373
<li><a href="api/async_context.html#_CPPv4N2v010blocked_by8externalE">v0::blocked_by::external (C++ enumerator)</a>
@@ -392,35 +390,43 @@ <h2 id="V">V</h2>
392390
</li>
393391
<li><a href="api/async_context.html#_CPPv4N2v07context13block_by_syncEP7context">v0::context::block_by_sync (C++ function)</a>
394392
</li>
395-
<li><a href="api/async_context.html#_CPPv4N2v07context13block_by_timeE14sleep_duration">v0::context::block_by_time (C++ function)</a>
393+
<li><a href="api/async_context.html#_CPPv4I00EN2v07context13block_by_timeENSt14suspend_alwaysENSt6chrono8durationI3Rep6PeriodEE">v0::context::block_by_time (C++ function)</a>
396394
</li>
397395
<li><a href="api/async_context.html#_CPPv4N2v07context6cancelEv">v0::context::cancel (C++ function)</a>
398396
</li>
399397
<li><a href="api/async_context.html#_CPPv4NK2v07context8capacityEv">v0::context::capacity (C++ function)</a>
400398
</li>
401-
<li><a href="api/async_context.html#_CPPv4N2v07context7contextERK7context">v0::context::context (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v07context7contextERR7context">[1]</a>, <a href="api/async_context.html#_CPPv4N2v07context7contextEv">[2]</a>
399+
<li><a href="api/async_context.html#_CPPv4N2v07context22clear_unblock_listenerEv">v0::context::clear_unblock_listener (C++ function)</a>
400+
</li>
401+
<li><a href="api/async_context.html#_CPPv4N2v07context7contextENSt4spanI4uptrEE">v0::context::context (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v07context7contextERK7context">[1]</a>, <a href="api/async_context.html#_CPPv4N2v07context7contextERR7context">[2]</a>, <a href="api/async_context.html#_CPPv4N2v07context7contextEv">[3]</a>
402+
</li>
403+
<li><a href="api/async_context.html#_CPPv4NK2v07context4doneEv">v0::context::done (C++ function)</a>
402404
</li>
403-
<li><a href="api/async_context.html#_CPPv4N2v07context4doneEv">v0::context::done (C++ function)</a>
405+
<li><a href="api/async_context.html#_CPPv4NK2v07context11get_blockerEv">v0::context::get_blocker (C++ function)</a>
404406
</li>
405407
<li><a href="api/async_context.html#_CPPv4N2v07context23initialize_stack_memoryENSt4spanI4uptrEE">v0::context::initialize_stack_memory (C++ function)</a>
406408
</li>
407409
<li><a href="api/async_context.html#_CPPv4NK2v07context16memory_remainingEv">v0::context::memory_remaining (C++ function)</a>
408410
</li>
409411
<li><a href="api/async_context.html#_CPPv4NK2v07context11memory_usedEv">v0::context::memory_used (C++ function)</a>
412+
</li>
413+
<li><a href="api/async_context.html#_CPPv4N2v07context10on_unblockEP16unblock_listener">v0::context::on_unblock (C++ function)</a>
410414
</li>
411415
<li><a href="api/async_context.html#_CPPv4N2v07contextaSERK7context">v0::context::operator= (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v07contextaSERR7context">[1]</a>
412416
</li>
413417
<li><a href="api/async_context.html#_CPPv4N2v07context6resumeEv">v0::context::resume (C++ function)</a>
414418
</li>
415-
<li><a href="api/async_context.html#_CPPv4NK2v07context5stateEv">v0::context::state (C++ function)</a>
419+
<li><a href="api/async_context.html#_CPPv4NK2v07context10sleep_timeEv">v0::context::sleep_time (C++ function)</a>
416420
</li>
417-
<li><a href="api/async_context.html#_CPPv4N2v07context7unblockEv">v0::context::unblock (C++ function)</a>
421+
<li><a href="api/async_context.html#_CPPv4NK2v07context5stateEv">v0::context::state (C++ function)</a>
418422
</li>
419423
</ul></td>
420424
<td style="width: 33%; vertical-align: top;"><ul>
421-
<li><a href="api/async_context.html#_CPPv4N2v07context28unblock_without_notificationEv">v0::context::unblock_without_notification (C++ function)</a>
425+
<li><a href="api/async_context.html#_CPPv4N2v07context9sync_waitERRNSt9invocableI14sleep_durationEE">v0::context::sync_wait (C++ function)</a>
422426
</li>
423-
<li><a href="api/async_context.html#_CPPv4N2v07contextD0Ev">v0::context::~context (C++ function)</a>
427+
<li><a href="api/async_context.html#_CPPv4N2v07context7unblockEv">v0::context::unblock (C++ function)</a>
428+
</li>
429+
<li><a href="api/async_context.html#_CPPv4N2v07context28unblock_without_notificationEv">v0::context::unblock_without_notification (C++ function)</a>
424430
</li>
425431
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_accessE">v0::exclusive_access (C++ class)</a>
426432
</li>

async_context/main/index.html

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -378,34 +378,36 @@ <h1>async_context API documentation<a class="headerlink" href="#async-context-ap
378378
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#id1">async::context</a><ul>
379379
<li class="toctree-l3"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07contextE"><code class="docutils literal notranslate"><span class="pre">v0::context</span></code></a><ul>
380380
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context7contextEv"><code class="docutils literal notranslate"><span class="pre">context()</span></code></a></li>
381+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context7contextENSt4spanI4uptrEE"><code class="docutils literal notranslate"><span class="pre">context()</span></code></a></li>
381382
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context7contextERK7context"><code class="docutils literal notranslate"><span class="pre">context()</span></code></a></li>
382383
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07contextaSERK7context"><code class="docutils literal notranslate"><span class="pre">operator=()</span></code></a></li>
383384
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context7contextERR7context"><code class="docutils literal notranslate"><span class="pre">context()</span></code></a></li>
384385
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07contextaSERR7context"><code class="docutils literal notranslate"><span class="pre">operator=()</span></code></a></li>
385386
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context23initialize_stack_memoryENSt4spanI4uptrEE"><code class="docutils literal notranslate"><span class="pre">initialize_stack_memory()</span></code></a></li>
386-
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context7unblockEv"><code class="docutils literal notranslate"><span class="pre">unblock()</span></code></a></li>
387387
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context28unblock_without_notificationEv"><code class="docutils literal notranslate"><span class="pre">unblock_without_notification()</span></code></a></li>
388-
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context13block_by_timeE14sleep_duration"><code class="docutils literal notranslate"><span class="pre">block_by_time()</span></code></a></li>
388+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context7unblockEv"><code class="docutils literal notranslate"><span class="pre">unblock()</span></code></a></li>
389+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4I00EN2v07context13block_by_timeENSt14suspend_alwaysENSt6chrono8durationI3Rep6PeriodEE"><code class="docutils literal notranslate"><span class="pre">block_by_time()</span></code></a></li>
389390
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context11block_by_ioE14sleep_duration"><code class="docutils literal notranslate"><span class="pre">block_by_io()</span></code></a></li>
390391
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context13block_by_syncEP7context"><code class="docutils literal notranslate"><span class="pre">block_by_sync()</span></code></a></li>
391392
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context17block_by_externalEv"><code class="docutils literal notranslate"><span class="pre">block_by_external()</span></code></a></li>
392393
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context13active_handleEv"><code class="docutils literal notranslate"><span class="pre">active_handle()</span></code></a></li>
393394
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context5stateEv"><code class="docutils literal notranslate"><span class="pre">state()</span></code></a></li>
394-
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context4doneEv"><code class="docutils literal notranslate"><span class="pre">done()</span></code></a></li>
395+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context4doneEv"><code class="docutils literal notranslate"><span class="pre">done()</span></code></a></li>
395396
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context6cancelEv"><code class="docutils literal notranslate"><span class="pre">cancel()</span></code></a></li>
396397
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context6resumeEv"><code class="docutils literal notranslate"><span class="pre">resume()</span></code></a></li>
398+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context9sync_waitERRNSt9invocableI14sleep_durationEE"><code class="docutils literal notranslate"><span class="pre">sync_wait()</span></code></a></li>
397399
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context11memory_usedEv"><code class="docutils literal notranslate"><span class="pre">memory_used()</span></code></a></li>
398400
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context8capacityEv"><code class="docutils literal notranslate"><span class="pre">capacity()</span></code></a></li>
399401
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context16memory_remainingEv"><code class="docutils literal notranslate"><span class="pre">memory_remaining()</span></code></a></li>
400-
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07contextD0Ev"><code class="docutils literal notranslate"><span class="pre">~context()</span></code></a></li>
401-
</ul>
402-
</li>
402+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context10sleep_timeEv"><code class="docutils literal notranslate"><span class="pre">sleep_time()</span></code></a></li>
403+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context10on_unblockEP16unblock_listener"><code class="docutils literal notranslate"><span class="pre">on_unblock()</span></code></a></li>
404+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v07context22clear_unblock_listenerEv"><code class="docutils literal notranslate"><span class="pre">clear_unblock_listener()</span></code></a></li>
405+
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4NK2v07context11get_blockerEv"><code class="docutils literal notranslate"><span class="pre">get_blocker()</span></code></a></li>
403406
</ul>
404407
</li>
405-
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#async-basic-context">async::basic_context</a><ul>
406-
<li class="toctree-l3"><a class="reference internal" href="api/async_context.html#_CPPv4I_6size_tEN2v013basic_contextE"><code class="docutils literal notranslate"><span class="pre">v0::basic_context</span></code></a></li>
407408
</ul>
408409
</li>
410+
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#async-inplace-context">async::inplace_context</a></li>
409411
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#async-proxy-context">async::proxy_context</a><ul>
410412
<li class="toctree-l3"><a class="reference internal" href="api/async_context.html#_CPPv4N2v013proxy_contextE"><code class="docutils literal notranslate"><span class="pre">v0::proxy_context</span></code></a><ul>
411413
<li class="toctree-l4"><a class="reference internal" href="api/async_context.html#_CPPv4N2v013proxy_context13proxy_contextERK13proxy_context"><code class="docutils literal notranslate"><span class="pre">proxy_context()</span></code></a></li>

async_context/main/objects.inv

256 Bytes
Binary file not shown.

async_context/main/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)