mirror of
https://github.com/cloudflare/cloudflared.git
synced 2025-05-30 13:46:35 +00:00
475939a77f
The idle period is set to 5sec. We now also ping every second since last activity. This makes the quic.Connection less prone to being closed with no network activity, since we send multiple pings per idle period, and thus a single packet loss cannot cause the problem.
61 lines
4.2 KiB
Markdown
61 lines
4.2 KiB
Markdown
# A QUIC implementation in pure Go
|
|
|
|
<img src="docs/quic.png" width=303 height=124>
|
|
|
|
[](https://pkg.go.dev/github.com/lucas-clemente/quic-go)
|
|
[](https://codecov.io/gh/lucas-clemente/quic-go/)
|
|
|
|
quic-go is an implementation of the [QUIC protocol, RFC 9000](https://datatracker.ietf.org/doc/html/rfc9000) protocol in Go.
|
|
In addition to RFC 9000, it currently implements the [IETF QUIC draft-29](https://tools.ietf.org/html/draft-ietf-quic-transport-29). Support for draft-29 will eventually be dropped, as it is phased out of the ecosystem.
|
|
|
|
## Guides
|
|
|
|
*We currently support Go 1.16.x, Go 1.17.x, and Go 1.18.x.*
|
|
|
|
Running tests:
|
|
|
|
go test ./...
|
|
|
|
### QUIC without HTTP/3
|
|
|
|
Take a look at [this echo example](example/echo/echo.go).
|
|
|
|
## Usage
|
|
|
|
### As a server
|
|
|
|
See the [example server](example/main.go). Starting a QUIC server is very similar to the standard lib http in go:
|
|
|
|
```go
|
|
http.Handle("/", http.FileServer(http.Dir(wwwDir)))
|
|
http3.ListenAndServeQUIC("localhost:4242", "/path/to/cert/chain.pem", "/path/to/privkey.pem", nil)
|
|
```
|
|
|
|
### As a client
|
|
|
|
See the [example client](example/client/main.go). Use a `http3.RoundTripper` as a `Transport` in a `http.Client`.
|
|
|
|
```go
|
|
http.Client{
|
|
Transport: &http3.RoundTripper{},
|
|
}
|
|
```
|
|
|
|
## Projects using quic-go
|
|
|
|
| Project | Description | Stars |
|
|
|------------------------------------------------------|--------------------------------------------------------------------------------------------------------|-------|
|
|
| [algernon](https://github.com/xyproto/algernon) | Small self-contained pure-Go web server with Lua, Markdown, HTTP/2, QUIC, Redis and PostgreSQL support |  |
|
|
| [caddy](https://github.com/caddyserver/caddy/) | Fast, multi-platform web server with automatic HTTPS |  |
|
|
| [go-ipfs](https://github.com/ipfs/go-ipfs) | IPFS implementation in go |  |
|
|
| [syncthing](https://github.com/syncthing/syncthing/) | Open Source Continuous File Synchronization |  |
|
|
| [traefik](https://github.com/traefik/traefik) | The Cloud Native Application Proxy |  |
|
|
| [v2ray-core](https://github.com/v2fly/v2ray-core) | A platform for building proxies to bypass network restrictions |  |
|
|
| [cloudflared](https://github.com/cloudflare/cloudflared) | A tunneling daemon that proxies traffic from the Cloudflare network to your origins |  |
|
|
| [OONI Probe](https://github.com/ooni/probe-cli) | The Open Observatory of Network Interference (OONI) aims to empower decentralized efforts in documenting Internet censorship around the world. |  |
|
|
|
|
|
|
## Contributing
|
|
|
|
We are always happy to welcome new contributors! We have a number of self-contained issues that are suitable for first-time contributors, they are tagged with [help wanted](https://github.com/lucas-clemente/quic-go/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). If you have any questions, please feel free to reach out by opening an issue or leaving a comment.
|