Skip to content

docs: document asynchronous networking - #35

Open
aazainjan wants to merge 1 commit into
tglane:v2from
aazainjan:docs/async-networking
Open

docs: document asynchronous networking#35
aazainjan wants to merge 1 commit into
tglane:v2from
aazainjan:docs/async-networking

Conversation

@aazainjan

Copy link
Copy Markdown

Summary

  • Documented Socketwrapper's asynchronous networking functionality
  • Explained callback-based operations
  • Documented future-based operations
  • Added an overview of C++20 coroutine support
  • Documented async_run(), block_on(), and spawn()

Motivation

The README previously contained a TODO for the asynchronous functionality.
This change replaces the TODO with documentation for the asynchronous APIs
already provided by the library.

@tglane

tglane commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Hi and thank you for your PR. You've added documentation for the callback based asynchronous functions but not for the ones that return a std::promise or an awaitable that's useable in coroutines. Could you add that, too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants