You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

53 lines
1.7 KiB
Markdown

![Build project](https://github.com/netty/netty-incubator-codec-quic/workflows/Build%20project/badge.svg)
# Netty QUIC codec
This is a new experimental QUIC codec for netty which makes use of [quiche](https://github.com/cloudflare/quiche).
## How to include the dependency
To include the dependency you need to ensure you also specify the right classifier. At the moment we only support Linux
x86_64 / aarch_64, macOS / OSX x86_64 / aarch_64 and Windows x86_64 but this may change.
As an example this is how you would include the dependency in maven:
For Linux x86_64:
```
<dependency>
<groupId>io.netty.incubator</groupId>
<artifactId>netty-incubator-codec-native-quic</artifactId>
<version>0.0.21.Final</version>
<classifier>linux-x86_64</classifier>
</dependency>
```
For macOS / OSX:
```
<dependency>
<groupId>io.netty.incubator</groupId>
<artifactId>netty-incubator-codec-native-quic</artifactId>
<version>0.0.21.Final</version>
<classifier>osx-x86_64</classifier>
</dependency>
```
For Windows:
```
<dependency>
<groupId>io.netty.incubator</groupId>
<artifactId>netty-incubator-codec-native-quic</artifactId>
<version>0.0.21.Final</version>
<classifier>windows-x86_64</classifier>
</dependency>
```
## How to use this codec ?
For some examples please check our
[example package](https://github.com/netty/netty-incubator-codec-quic/tree/main/codec-native-quic/src/test/java/io/netty/incubator/codec/quic).
This contains a server and a client that can speak some limited HTTP/0.9 with each other.
For more "advanced" use cases, consider checking our
[netty-incubator-codec-http3](https://github.com/netty/netty-incubator-codec-http3) project.