2022-01-18 22:05:25 +03:00
< h1 align = "center" > < img src = "docs/images/readme_logo.png" width = "500" alt = "MsQuic logo" / > < / h1 >
2023-10-06 01:52:01 +03:00
[](https://microsoft.github.io/msquic/msquicdocs/docs/API.html)
2022-04-01 22:00:12 +03:00
[](https://microsoft.github.io/msquic/)
2023-08-10 23:35:04 +03:00
[](https://github.com/microsoft/msquic/actions/workflows/build.yml?query=branch%3Amain)
[](https://github.com/microsoft/msquic/actions/workflows/test.yml?query=branch%3Amain)
[](https://github.com/microsoft/msquic/actions/workflows/stress.yml?query=branch%3Amain)
2023-07-10 13:50:19 +03:00
[](https://codecov.io/github/microsoft/msquic)
2022-04-01 22:00:12 +03:00
[](https://bestpractices.coreinfrastructure.org/projects/4846)
[](https://discord.gg/YGAtCwTSsc)
[](https://crates.io/crates/msquic)
[](https://www.nuget.org/profiles/msquic)
2020-05-13 05:08:05 +03:00
2020-11-09 19:45:40 +03:00
MsQuic is a Microsoft implementation of the [IETF QUIC ](https://datatracker.ietf.org/wg/quic/about/ )
2022-04-12 15:20:21 +03:00
protocol. It is cross-platform, written in C and designed to be a general purpose QUIC library. MsQuic also has C++ API wrapper classes and exposes interop layers for both Rust and C#.
2020-05-13 05:08:05 +03:00
## Protocol Features
2022-04-01 22:00:12 +03:00
[](https://tools.ietf.org/html/rfc9000)
[](https://tools.ietf.org/html/rfc9001)
[](https://tools.ietf.org/html/rfc9002)
[](https://tools.ietf.org/html/rfc9221)
2022-08-24 13:57:26 +03:00
[](https://tools.ietf.org/html/rfc9287)
2023-08-10 23:35:04 +03:00
[](https://tools.ietf.org/html/rfc9368)
[](https://tools.ietf.org/html/rfc9369)
2022-04-01 22:00:12 +03:00
[](https://tools.ietf.org/html/draft-ietf-quic-load-balancers)
[](https://tools.ietf.org/html/draft-ietf-quic-ack-frequency)
[](https://tools.ietf.org/html/draft-banks-quic-disable-encryption)
[](https://tools.ietf.org/html/draft-banks-quic-performance)
[](https://tools.ietf.org/html/draft-banks-quic-cibir)
2023-09-12 20:37:30 +03:00
[](https://tools.ietf.org/html/draft-huitema-quic-ts)
2023-10-12 21:37:01 +03:00
[](https://datatracker.ietf.org/doc/draft-ietf-quic-reliable-stream-reset/)
2021-06-02 20:00:02 +03:00
2020-11-09 19:45:40 +03:00
QUIC has many benefits when compared to existing "TLS over TCP" scenarios:
2020-05-13 05:08:05 +03:00
2020-11-09 19:45:40 +03:00
* All packets are encrypted and handshake is authenticated with TLS 1.3.
* Parallel streams of (reliable and unreliable) application data.
2020-05-13 05:08:05 +03:00
* Exchange application data in the first round trip (0-RTT).
2020-11-09 19:45:40 +03:00
* Improved congestion control and loss recovery.
2020-05-13 05:08:05 +03:00
* Survives a change in the clients IP address or port.
2020-10-01 00:56:32 +03:00
* Stateless load balancing.
2020-10-13 17:44:31 +03:00
* Easily extendable for new features and extensions.
2020-10-01 00:56:32 +03:00
2020-05-13 05:08:05 +03:00
## Library Features
2020-11-11 00:24:40 +03:00
MsQuic has several features that differentiates it from other QUIC implementations:
2020-05-13 05:08:05 +03:00
* Optimized for client and server.
* Optimized for maximal throughput and minimal latency.
* Asynchronous IO.
2020-11-11 00:24:40 +03:00
* Receive side scaling ([RSS](https://docs.microsoft.com/en-us/windows-hardware/drivers/network/introduction-to-receive-side-scaling)) support.
2020-05-13 05:08:05 +03:00
* UDP send and receive coalescing support.
# Documentation
2020-11-11 00:24:40 +03:00
* For platform support details, see the [Platforms docs ](./docs/Platforms.md ).
* For release details, see the [Release docs ](./docs/Release.md ).
* For performance data, see the [Performance dashboard ](https://aka.ms/msquicperformance ).
2021-08-04 02:26:44 +03:00
* For building the library, see the [Build docs ](./docs/BUILD.md ).
* For testing the library, see the [Testing docs ](./docs/TEST.md ).
* For using the API, see the [API docs ](./docs/API.md ) or the [Sample ](./src/tools/sample/sample.c ).
2023-12-06 00:32:34 +03:00
* For running a sample server and client app, see the [Quick Start Guide ](./docs/Sample.md ).
2021-08-04 02:26:44 +03:00
* For deploying QUIC, see the [Deployment docs ](./docs/Deployment.md ).
* For diagnosing issues, see the [Diagnostics docs ](./docs/Diagnostics.md ) and the [Trouble Shooting Guide ](./docs/TSG.md ).
2021-06-02 20:00:02 +03:00
* For other frequently asked questions, see the [FAQs ](./docs/FAQ.md ).
2020-05-13 05:08:05 +03:00
# Contributing
2023-04-06 19:40:03 +03:00
For information on contributing, please see our [contribution guidelines ](./.github/CONTRIBUTING.md ). Feel free to take a look at our [Good First Issues ](https://github.com/microsoft/msquic/labels/good%20first%20issue ) list if you're looking for somewhere to start. If you'd just like to talk, come chat with us [on Discord ](https://discord.gg/YGAtCwTSsc ).
