Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emqx/quic
QUIC protocol for Erlang & Elixir
https://github.com/emqx/quic
Last synced: about 2 months ago
JSON representation
QUIC protocol for Erlang & Elixir
- Host: GitHub
- URL: https://github.com/emqx/quic
- Owner: emqx
- License: apache-2.0
- Created: 2020-01-27T07:02:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T14:50:37.000Z (3 months ago)
- Last Synced: 2024-04-06T16:44:03.699Z (2 months ago)
- Language: Erlang
- Homepage: https://www.emqx.com
- Size: 1.78 MB
- Stars: 198
- Watchers: 26
- Forks: 33
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Lists
- awesome-elixir - quicer - QUIC protocol erlang library. (QUIC)
- fucking-awesome-elixir - quicer - QUIC protocol erlang library. (QUIC)
README
# quicer
QUIC protocol erlang library.
[msquic](https://github.com/microsoft/msquic) NIF binding.
Project Status: WIP (actively), POC quality
API: is not stable, might be changed in the future.
[](https://opensource.org/licenses/Apache-2.0)
[](https://coveralls.io/r/emqx/quic?branch=main)
# OS Support
| OS | Status |
|---------|-----------|
| Linux | Supported |
| macOS | Supported |
| Windows | TBD |
# BUILD
## Dependencies
1. OTP22+
1. rebar3
1. cmake3.16+
1. [CLOG](https://github.com/microsoft/CLOG) (required for debug logging only)
1. LTTNG2.12 (required for debug build only)
## With DEBUG
Debug build dependency: [CLOG](https://github.com/microsoft/CLOG)
``` sh
$ rebar3 compile
# OR
$ make
```
note,
To enable logging and release build:
``` sh
export CMAKE_BUILD_TYPE=Debug
export QUIC_ENABLE_LOGGING=ON
export QUICER_USE_LTTNG=1
make
```
## BUILD with logging to stdout
``` sh
QUIC_LOGGING_TYPE=stdout make
```
## Without DEBUG
``` sh
export CMAKE_BUILD_TYPE=Release
make
```
# Examples
## Ping Pong server and client
### Server
``` erlang
application:ensure_all_started(quicer),
Port = 4567,
LOptions = [ {certfile, "cert.pem"}
, {keyfile, "key.pem"}
, {alpn, ["sample"]}
, {peer_bidi_stream_count, 1}
],
{ok, L} = quicer:listen(Port, LOptions),
{ok, Conn} = quicer:accept(L, [], 120000),
{ok, Conn} = quicer:handshake(Conn),
{ok, Stm} = quicer:accept_stream(Conn, []),
receive {quic, <<"ping">>, Stm, _Props} -> ok end,
{ok, 4} = quicer:send(Stm, <<"pong">>),
quicer:close_listener(L).
```
### Client
``` erlang
application:ensure_all_started(quicer),
Port = 4567,
{ok, Conn} = quicer:connect("localhost", Port, [{alpn, ["sample"]}, {verify, none}], 5000),
{ok, Stm} = quicer:start_stream(Conn, []),
{ok, 4} = quicer:send(Stm, <<"ping">>),
receive {quic, <<"pong">>, Stm, _Props} -> ok end,
ok = quicer:close_connection(Conn).
```
# TEST
``` sh
$ make test
```
# Documentation
``` sh
$ make doc
```
Then check the doc in browser:
``` sh
$ firefox doc/index.html
```
# License
Apache License Version 2.0