Skip to content

Add async_context main API documentation #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kammce merged 1 commit into from
Mar 16, 2026
Merged

Add async_context main API documentation #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified async_context/main/.doctrees/api/async_context.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified async_context/main/.doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion async_context/main/_sources/api/async_context.md.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Defined in namespace `async::v0`
```{doxygenclass} v0::context
```

## async::basic_context
## async::inplace_context

Defined in namespace `async::v0`

Expand Down
183 changes: 131 additions & 52 deletions async_context/main/api/async_context.html
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 15 additions & 9 deletions async_context/main/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,8 +368,6 @@ <h1 id="index">Index</h1>
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/async_context.html#_CPPv4I_6size_tEN2v013basic_contextE">v0::basic_context (C++ class)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v010blocked_byE">v0::blocked_by (C++ enum)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v010blocked_by8externalE">v0::blocked_by::external (C++ enumerator)</a>
Expand All @@ -392,35 +390,43 @@ <h2 id="V">V</h2>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context13block_by_syncEP7context">v0::context::block_by_sync (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context13block_by_timeE14sleep_duration">v0::context::block_by_time (C++ function)</a>
<li><a href="api/async_context.html#_CPPv4I00EN2v07context13block_by_timeENSt14suspend_alwaysENSt6chrono8durationI3Rep6PeriodEE">v0::context::block_by_time (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context6cancelEv">v0::context::cancel (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4NK2v07context8capacityEv">v0::context::capacity (C++ function)</a>
</li>
<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>
<li><a href="api/async_context.html#_CPPv4N2v07context22clear_unblock_listenerEv">v0::context::clear_unblock_listener (C++ function)</a>
</li>
<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>
</li>
<li><a href="api/async_context.html#_CPPv4NK2v07context4doneEv">v0::context::done (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context4doneEv">v0::context::done (C++ function)</a>
<li><a href="api/async_context.html#_CPPv4NK2v07context11get_blockerEv">v0::context::get_blocker (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context23initialize_stack_memoryENSt4spanI4uptrEE">v0::context::initialize_stack_memory (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4NK2v07context16memory_remainingEv">v0::context::memory_remaining (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4NK2v07context11memory_usedEv">v0::context::memory_used (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context10on_unblockEP16unblock_listener">v0::context::on_unblock (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07contextaSERK7context">v0::context::operator= (C++ function)</a>, <a href="api/async_context.html#_CPPv4N2v07contextaSERR7context">[1]</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context6resumeEv">v0::context::resume (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4NK2v07context5stateEv">v0::context::state (C++ function)</a>
<li><a href="api/async_context.html#_CPPv4NK2v07context10sleep_timeEv">v0::context::sleep_time (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context7unblockEv">v0::context::unblock (C++ function)</a>
<li><a href="api/async_context.html#_CPPv4NK2v07context5stateEv">v0::context::state (C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/async_context.html#_CPPv4N2v07context28unblock_without_notificationEv">v0::context::unblock_without_notification (C++ function)</a>
<li><a href="api/async_context.html#_CPPv4N2v07context9sync_waitERRNSt9invocableI14sleep_durationEE">v0::context::sync_wait (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07contextD0Ev">v0::context::~context (C++ function)</a>
<li><a href="api/async_context.html#_CPPv4N2v07context7unblockEv">v0::context::unblock (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v07context28unblock_without_notificationEv">v0::context::unblock_without_notification (C++ function)</a>
</li>
<li><a href="api/async_context.html#_CPPv4N2v016exclusive_accessE">v0::exclusive_access (C++ class)</a>
</li>
Expand Down
18 changes: 10 additions & 8 deletions async_context/main/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,34 +378,36 @@ <h1>async_context API documentation<a class="headerlink" href="#async-context-ap
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#id1">async::context</a><ul>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</ul>
</li>
<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>
<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>
<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>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#async-basic-context">async::basic_context</a><ul>
<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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#async-inplace-context">async::inplace_context</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/async_context.html#async-proxy-context">async::proxy_context</a><ul>
<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>
<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>
Expand Down
Binary file modified async_context/main/objects.inv
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion async_context/main/searchindex.js
View file
Open in desktop

Large diffs are not rendered by default.