Skip to content

Commit

Permalink
🎨 Update README to include windows CI
Browse files Browse the repository at this point in the history
  • Loading branch information
Thalhammer committed Jul 13, 2024
1 parent 52bf1dc commit 94f51ed
Showing 1 changed file with 24 additions and 13 deletions.
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,32 @@
This library provides a c++20 coroutine wrapper for networking and IO related functionality.
It is an addition to [async++](https://github.com/asyncpp/asyncpp) which provides general coroutine tasks and support classes.

This library is developed and tested on Ubuntu linux. There is also experimental support for MacOS.
Windows support is planned but not yet finished.
The library supports multiple IO backends for the various operating systems:
- select (Linux, MacOS)
- io_uring (Linux 5.1+)
- IOCP (Windows)

Features include:
- Asynchronous socket IO
- Asynchronous file IO (only on uring & IOCP)
- Convenient handling of ips and endpoints
- Coroutine ready wrapper for OpenSSL TLS
- Asynchronous DNS client with support for TSIG
- Ability to cancel most operations using stop_tokens
- Support for error handling using std::error_code or exceptions

Tested and supported compilers:
| Linux | MacOS (best effort) |
|-----------------------------------------------------------------------|---------------------------------------------------------------------|
| [![ubuntu-2004_clang-10][img_ubuntu-2004_clang-10]][Compiler-Support] | [![macos-12_clang-15][img_macos-12_clang-15]][Compiler-Support] |
| [![ubuntu-2004_clang-11][img_ubuntu-2004_clang-11]][Compiler-Support] | [![macos-12_gcc-12][img_macos-12_gcc-12]][Compiler-Support] |
| [![ubuntu-2004_clang-12][img_ubuntu-2004_clang-12]][Compiler-Support] | [![macos-12_gcc-14][img_macos-12_gcc-14]][Compiler-Support] |
| [![ubuntu-2004_gcc-10][img_ubuntu-2004_gcc-10]][Compiler-Support] | [![macos-13_clang-15][img_macos-13_clang-15]][Compiler-Support] |
| [![ubuntu-2204_clang-13][img_ubuntu-2204_clang-13]][Compiler-Support] | [![macos-13_gcc-12][img_macos-13_gcc-12]][Compiler-Support] |
| [![ubuntu-2204_clang-14][img_ubuntu-2204_clang-14]][Compiler-Support] | [![macos-13_gcc-14][img_macos-13_gcc-14]][Compiler-Support] |
| [![ubuntu-2204_clang-15][img_ubuntu-2204_clang-15]][Compiler-Support] | [![macos-14_clang-15][img_macos-14_clang-15]][Compiler-Support] |
| [![ubuntu-2204_gcc-11][img_ubuntu-2204_gcc-11]][Compiler-Support] | [![macos-14_gcc-12][img_macos-14_gcc-12]][Compiler-Support] |
| [![ubuntu-2204_gcc-10][img_ubuntu-2204_gcc-10]][Compiler-Support] | [![macos-14_gcc-14][img_macos-14_gcc-14]][Compiler-Support] |
| Linux | Windows | MacOS (best effort) |
|-----------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------------------|
| [![ubuntu-2004_clang-10][img_ubuntu-2004_clang-10]][Compiler-Support] | [![windows-2019_msvc16][img_windows-2019_msvc16]][Compiler-Support] | [![macos-12_clang-15][img_macos-12_clang-15]][Compiler-Support] |
| [![ubuntu-2004_clang-11][img_ubuntu-2004_clang-11]][Compiler-Support] | [![windows-2022_msvc17][img_windows-2022_msvc17]][Compiler-Support] | [![macos-12_gcc-12][img_macos-12_gcc-12]][Compiler-Support] |
| [![ubuntu-2004_clang-12][img_ubuntu-2004_clang-12]][Compiler-Support] | | [![macos-12_gcc-14][img_macos-12_gcc-14]][Compiler-Support] |
| [![ubuntu-2004_gcc-10][img_ubuntu-2004_gcc-10]][Compiler-Support] | | [![macos-13_clang-15][img_macos-13_clang-15]][Compiler-Support] |
| [![ubuntu-2204_clang-13][img_ubuntu-2204_clang-13]][Compiler-Support] | | [![macos-13_gcc-12][img_macos-13_gcc-12]][Compiler-Support] |
| [![ubuntu-2204_clang-14][img_ubuntu-2204_clang-14]][Compiler-Support] | | [![macos-13_gcc-14][img_macos-13_gcc-14]][Compiler-Support] |
| [![ubuntu-2204_clang-15][img_ubuntu-2204_clang-15]][Compiler-Support] | | [![macos-14_clang-15][img_macos-14_clang-15]][Compiler-Support] |
| [![ubuntu-2204_gcc-11][img_ubuntu-2204_gcc-11]][Compiler-Support] | | [![macos-14_gcc-12][img_macos-14_gcc-12]][Compiler-Support] |
| [![ubuntu-2204_gcc-10][img_ubuntu-2204_gcc-10]][Compiler-Support] | | [![macos-14_gcc-14][img_macos-14_gcc-14]][Compiler-Support] |


[img_ubuntu-2004_clang-10]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/asyncpp/asyncpp-io/badges/compiler/ubuntu-2004_clang-10/shields.json
Expand Down

0 comments on commit 94f51ed

Please sign in to comment.