Skip to content

Commit 68ae62f

Browse files
author
QUIC Dev[bot]
committed
Update DocFx after documentation changes.
1 parent c227199 commit 68ae62f

356 files changed

Lines changed: 25801 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎msquicdocs/README.html‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title> </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content=" ">
8+
9+
10+
<link rel="icon" href="favicon.ico">
11+
<link rel="stylesheet" href="public/docfx.min.css">
12+
<link rel="stylesheet" href="public/main.css">
13+
<meta name="docfx:navrel" content="toc.html">
14+
<meta name="docfx:tocrel" content="toc.html">
15+
16+
<meta name="docfx:rel" content="">
17+
18+
19+
<meta name="docfx:docurl" content="https://github.com/seera-networks/msquic/blob/main/README.md/#L1">
20+
<meta name="loc:inThisArticle" content="In this article">
21+
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
22+
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
23+
<meta name="loc:tocFilter" content="Filter by title">
24+
<meta name="loc:nextArticle" content="Next">
25+
<meta name="loc:prevArticle" content="Previous">
26+
<meta name="loc:themeLight" content="Light">
27+
<meta name="loc:themeDark" content="Dark">
28+
<meta name="loc:themeAuto" content="Auto">
29+
<meta name="loc:changeTheme" content="Change theme">
30+
<meta name="loc:copy" content="Copy">
31+
<meta name="loc:downloadPdf" content="Download PDF">
32+
33+
<script type="module" src="./public/docfx.min.js"></script>
34+
35+
<script>
36+
const theme = localStorage.getItem('theme') || 'auto'
37+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
38+
</script>
39+
40+
</head>
41+
42+
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
43+
<header class="bg-body border-bottom">
44+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
45+
<div class="container-xxl flex-nowrap">
46+
<a class="navbar-brand" href="index.html">
47+
<img id="logo" class="svg" src="logo.svg" alt="">
48+
49+
</a>
50+
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
51+
<i class="bi bi-three-dots"></i>
52+
</button>
53+
<div class="collapse navbar-collapse" id="navpanel">
54+
<div id="navbar">
55+
<form class="search" role="search" id="search">
56+
<i class="bi bi-search"></i>
57+
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
58+
</form>
59+
</div>
60+
</div>
61+
</div>
62+
</nav>
63+
</header>
64+
65+
<main class="container-xxl">
66+
67+
<div class="content">
68+
<div class="actionbar">
69+
70+
<nav id="breadcrumb"></nav>
71+
</div>
72+
73+
<article data-uid="">
74+
<h1 align="center"><img src="docs/images/readme_logo.png" width="500" alt="MsQuic logo"></h1>
75+
76+
<p><a href="https://discord.gg/YGAtCwTSsc"><img src="https://img.shields.io/discord/827744285595271168?label=Discord&amp;logo=discord&amp;logoColor=white&amp;color=7289DA" alt="Discord"></a>
77+
<a href="https://microsoft.github.io/msquic/msquicdocs/docs/API.html"><img src="https://img.shields.io/static/v1?label=Documentation&amp;message=API&amp;color=yellow" alt="Documentation"></a>
78+
<a href="https://microsoft.github.io/netperf/dist/"><img src="https://img.shields.io/static/v1?label=Performance&amp;message=Dashboard&amp;color=blue" alt="Perf Dashboard"></a>
79+
<a href="https://codecov.io/github/microsoft/msquic"><img src="https://codecov.io/github/microsoft/msquic/branch/main/graph/badge.svg?token=xAjIMDn7wy" alt="codecov"></a>
80+
<a href="https://crates.io/crates/msquic"><img src="https://img.shields.io/crates/v/msquic" alt="crates.io"></a>
81+
<a href="https://www.nuget.org/profiles/msquic"><img src="https://img.shields.io/nuget/vpre/Microsoft.Native.Quic.MsQuic.Schannel?style=plastic" alt="nuget"></a>
82+
<a href="https://bestpractices.coreinfrastructure.org/projects/4846"><img src="https://bestpractices.coreinfrastructure.org/projects/4846/badge" alt="CII Best Practices"></a></p>
83+
<p>MsQuic is a Microsoft implementation of the <a href="https://datatracker.ietf.org/wg/quic/about/">IETF QUIC</a>
84+
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 <a href="https://docs.rs/msquic/latest/msquic/">Rust</a> and C#.</p>
85+
<div class="TIP">
86+
<h5>Tip</h5>
87+
<p>You are using MsQuic? Let us know! Knowing our users lets us prioritize work and keep improving MsQuic in the best possible direction.
88+
Post in the <a href="https://github.com/microsoft/msquic/discussions/4963">Discussion</a> to say hello and give us a wave on <a href="https://discord.gg/YGAtCwTSsc">Discord</a>!</p>
89+
</div>
90+
<h2 id="protocol-features">Protocol Features</h2>
91+
<p><a href="https://tools.ietf.org/html/rfc9000"><img src="https://img.shields.io/static/v1?label=RFC&amp;message=9000&amp;color=brightgreen" alt=""></a>
92+
<a href="https://tools.ietf.org/html/rfc9001"><img src="https://img.shields.io/static/v1?label=RFC&amp;message=9001&amp;color=brightgreen" alt=""></a>
93+
<a href="https://tools.ietf.org/html/rfc9002"><img src="https://img.shields.io/static/v1?label=RFC&amp;message=9002&amp;color=brightgreen" alt=""></a>
94+
<a href="https://tools.ietf.org/html/rfc9221"><img src="https://img.shields.io/static/v1?label=RFC&amp;message=9221&amp;color=brightgreen" alt=""></a>
95+
<a href="https://tools.ietf.org/html/rfc9287"><img src="https://img.shields.io/static/v1?label=RFC&amp;message=9287&amp;color=brightgreen" alt=""></a>
96+
<a href="https://tools.ietf.org/html/rfc9368"><img src="https://img.shields.io/static/v1?label=RFC&amp;message=9368&amp;color=brightgreen" alt=""></a>
97+
<a href="https://tools.ietf.org/html/rfc9369"><img src="https://img.shields.io/static/v1?label=RFC&amp;message=9369&amp;color=brightgreen" alt=""></a>
98+
<a href="https://tools.ietf.org/html/draft-ietf-quic-load-balancers"><img src="https://img.shields.io/static/v1?label=Draft&amp;message=Load%20Balancers&amp;color=blue" alt=""></a>
99+
<a href="https://tools.ietf.org/html/draft-ietf-quic-ack-frequency"><img src="https://img.shields.io/static/v1?label=Draft&amp;message=ACK%20Frequency&amp;color=blue" alt=""></a>
100+
<a href="https://tools.ietf.org/html/draft-banks-quic-disable-encryption"><img src="https://img.shields.io/static/v1?label=Draft&amp;message=Disable%20Encryption&amp;color=blueviolet" alt=""></a>
101+
<a href="https://tools.ietf.org/html/draft-banks-quic-performance"><img src="https://img.shields.io/static/v1?label=Draft&amp;message=Performance&amp;color=blueviolet" alt=""></a>
102+
<a href="https://tools.ietf.org/html/draft-banks-quic-cibir"><img src="https://img.shields.io/static/v1?label=Draft&amp;message=CIBIR&amp;color=blueviolet" alt=""></a>
103+
<a href="https://tools.ietf.org/html/draft-huitema-quic-ts"><img src="https://img.shields.io/static/v1?label=Draft&amp;message=Timestamps&amp;color=blueviolet" alt=""></a>
104+
<a href="https://datatracker.ietf.org/doc/draft-ietf-quic-reliable-stream-reset/"><img src="https://img.shields.io/static/v1?label=Draft&amp;message=ReliableReset&amp;color=blueviolet" alt=""></a></p>
105+
<p>QUIC has many benefits when compared to existing &quot;TLS over TCP&quot; scenarios:</p>
106+
<ul>
107+
<li>All packets are encrypted and handshake is authenticated with TLS 1.3.</li>
108+
<li>Parallel streams of (reliable and unreliable) application data.</li>
109+
<li>Exchange application data in the first round trip (0-RTT).</li>
110+
<li>Improved congestion control and loss recovery.</li>
111+
<li>Survives a change in the clients IP address or port.</li>
112+
<li>Stateless load balancing.</li>
113+
<li>Easily extendable for new features and extensions.</li>
114+
</ul>
115+
<h2 id="library-features">Library Features</h2>
116+
<p>MsQuic has several features that differentiates it from other QUIC implementations:</p>
117+
<ul>
118+
<li>Optimized for client and server.</li>
119+
<li>Optimized for maximal throughput and minimal latency.</li>
120+
<li>Asynchronous IO.</li>
121+
<li>Receive side scaling (<a href="https://docs.microsoft.com/en-us/windows-hardware/drivers/network/introduction-to-receive-side-scaling">RSS</a>) support.</li>
122+
<li>UDP send and receive coalescing support.</li>
123+
<li>Kernel stack bypass via <a href="https://github.com/microsoft/xdp-for-windows?tab=readme-ov-file#xdp-for-windows">XDP</a>.</li>
124+
</ul>
125+
<h1 id="documentation">Documentation</h1>
126+
<ul>
127+
<li>For platform support details, see the <a href="docs/Platforms.html">Platforms docs</a>.</li>
128+
<li>For release details and supported versions, see the <a href="docs/Release.html">Release docs</a>.</li>
129+
<li>For performance data, see the <a href="https://aka.ms/msquicperformance">Performance dashboard</a>.</li>
130+
<li>For building the library, see the <a href="docs/BUILD.html">Build docs</a>.</li>
131+
<li>For testing the library, see the <a href="docs/TEST.html">Testing docs</a>.</li>
132+
<li>For using the API, see the <a href="docs/API.html">API docs</a> or the <a href="./src/tools/sample/sample.c">Sample</a>.</li>
133+
<li>For running a sample server and client app, see the <a href="docs/Sample.html">Quick Start Guide</a>.</li>
134+
<li>For deploying QUIC, see the <a href="docs/Deployment.html">Deployment docs</a>.</li>
135+
<li>For diagnosing issues, see the <a href="docs/Diagnostics.html">Diagnostics docs</a> and the <a href="./docs/TroubleShootingGuide.md">Trouble Shooting Guide</a>.</li>
136+
<li>For other frequently asked questions, see the <a href="docs/FAQ.html">FAQs</a>.</li>
137+
<li>For contributor guides and internal design docs, see the <a href="./docs/contrib">Contributor docs</a>.</li>
138+
</ul>
139+
<h1 id="contributing">Contributing</h1>
140+
<p>For information on contributing, please see our <a href="./.github/CONTRIBUTING.md">contribution guidelines</a>.
141+
Feel free to take a look at our <a href="https://github.com/microsoft/msquic/labels/good%20first%20issue">Good First Issues</a> list if you're looking for somewhere to start.
142+
If you'd just like to talk, come chat with us <a href="https://discord.gg/YGAtCwTSsc">on Discord</a>.</p>
143+
144+
</article>
145+
146+
<div class="contribution d-print-none">
147+
<a href="https://github.com/seera-networks/msquic/blob/main/README.md/#L1" class="edit-link">Edit this page</a>
148+
</div>
149+
150+
<div class="next-article d-print-none border-top" id="nextArticle"></div>
151+
152+
</div>
153+
154+
<div class="affix">
155+
<nav id="affix"></nav>
156+
</div>
157+
</main>
158+
159+
<div class="container-xxl search-results" id="search-results"></div>
160+
161+
<footer class="border-top text-secondary">
162+
<div class="container-xxl">
163+
<div class="flex-fill">
164+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
165+
</div>
166+
</div>
167+
</footer>
168+
</body>
169+
</html>

0 commit comments

Comments
 (0)