Skip to content

docs: document asynchronous networking #35

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

Open
aazainjan wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

docs: document asynchronous networking #35

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
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,27 @@ this version!), and `pthreads` (you need to link with `lpthread`) and OpenSSL
There are some examples for all socket/connection types in the `examples` directory.

## Asyncronous functionality:
*TODO Describe the design of the asynchronous system*

Socketwrapper provides three interfaces for asynchronous network operations:

### Callback-based operations

The `async_*` methods return immediately and invoke a callback when the
operation completes. These methods are available for TCP, UDP, and TCP
acceptors.

Examples include:

- `tcp_connection::async_read()`
- `tcp_connection::async_send()`
- `tcp_acceptor::async_accept()`
- `udp_socket::async_read()`
- `udp_socket::async_send()`

The asynchronous context can be processed with:

```cpp
net::async_run();

## Class Documentation:
All of the following classes and enum classes live in the namespace `net`.
Expand Down