# ExQuic
[](https://hex.pm/packages/ex_quic)
[](https://hexdocs.pm/ex_quic/)
[](https://github.com/mickel8/ex_quic/actions)
Elixir wrapper over [lsquic].
ExQuic wraps [lsquic] for usage in Elixir.
At this moment it provides very simple and limited client that is able to communicate with [echo_server].
Future plans:
* extend client implementation
* implement server side
* add support for ECN
* add support for HTTP/3
## Installation
To successfully include `ex_quic` in your project you need to install:
* cmake (for building boringssl and lsquic)
* zlib (for lsquic)
* libevent-dev (for lsquic)
The package can be installed by adding `ex_quic` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_quic, "~> 0.1.0"}
]
end
```
## Quickstart
At this moment `ExQuic.Client` is able to communicate with [echo_server] written in C so to test it
you first need to start `echo_server`.
```
mix compile
cd third_party/lsquic
./echo_server -c www.example.com,/path/to/server.cert,/path/to/server.key -s 127.0.0.3:8989
```
Now you can write your own client and send a message to server from elixir
```elixir
defmodule ExampleClient do
use ExQuic.Client
@impl true
def handle_quic_payload({:quic_payload, _payload} = msg) do
IO.inspect(msg)
:ok
end
end
{:ok, pid} = Example.start_link(remote_ip: "127.0.0.3", remote_port: 8989)
Example.send_payload(pid, "hello\n")
```
`echo_server` expects the message to be end with `\n`
## Compilation warnings
There might be a lot of warnings during compilation related with `libev`.
They will be hopefully turned off in the future.
For more information please refer to `libev` [documentation](http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#COMPILER_WARNINGS)
## Architecture
ExQuic uses [bundlex] and [unifex] for compiling and spawning CNode that is responsible for doing
all QUIC stuff using [lsquic].
## Developing
To develop locally download submodules and use supported version of BoringSSL.
```
git submodule update --init --recursive
cd third_party/boringssl
git checkout a2278d4d2cabe73f6663e3299ea7808edfa306b9
```
[lsquic]: https://github.com/litespeedtech/lsquic
[bundlex]: https://github.com/membraneframework/bundlex
[unifex]: https://github.com/membraneframework/unifex
[echo_server]: https://github.com/litespeedtech/lsquic/blob/master/bin/echo_server.c
