README.md

Netty QUIC codec

This is a new experimental QUIC codec for netty which makes use of 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 and aarch64, macOS / OSX x86_64, Windows x86_64 and Android 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-quic</artifactId>
    <version>0.0.17.Final</version>
    <classifier>linux-x86_64</classifier>
</dependency>

For macOS / OSX:

<dependency>
    <groupId>io.netty.incubator</groupId>
    <artifactId>netty-incubator-codec-quic</artifactId>
    <version>0.0.17.Final</version>
    <classifier>osx-x86_64</classifier>
</dependency>

For Windows:

<dependency>
    <groupId>io.netty.incubator</groupId>
    <artifactId>netty-incubator-codec-quic</artifactId>
    <version>0.0.17.Final</version>
    <classifier>windows-x86_64</classifier>
</dependency>

For Android:

It's a single dependency that contains the following ABI: armeabi-v7a, arm64-v8a, x86, x86-64. If you don't need all ABI in your application, check out abiFilters.

<dependency>
    <groupId>io.netty.incubator</groupId>
    <artifactId>netty-incubator-codec-quic</artifactId>
    <version>0.0.16.Final</version>
    <classifier>android</classifier>
</dependency>

How to use this codec ?

For some examples please check our example package. 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 project.