glquic

# glquic

[![check](https://trev.zip/llc/glquic/actions/workflows/check.yaml/badge.svg?branch=main&logo=forgejo&logoColor=%23bac2de&label=check&labelColor=%23313244)](https://trev.zip/llc/glquic/actions?workflow=check.yaml)
[![vulnerable](https://trev.zip/llc/glquic/actions/workflows/vulnerable.yaml/badge.svg?branch=main&logo=forgejo&logoColor=%23bac2de&label=vulnerable&labelColor=%23313244)](https://trev.zip/llc/glquic/actions?workflow=vulnerable.yaml)
[![nixpkgs](https://img.shields.io/endpoint?url=https%3A%2F%2Fnix-shield.trev.zip%2Fbadge%3Furl%3Dhttps%253A%252F%252Ftrev.zip%252Fllc%252Fglquic%252Fraw%252Fbranch%252Fmain%252Fflake.lock%26input%3Dnixpkgs&logoColor=%23bac2de&labelColor=%23313244&color=%235277C3)](https://nixos.org/)
[![gleam](https://img.shields.io/badge/dynamic/toml?url=https://trev.zip/llc/glquic/raw/branch/main/gleam.toml&query=%24.gleam&logo=gleam&logoColor=%23bac2de&label=version&labelColor=%23313244&color=%23FFAFF3)](https://gleam.run/)
[![hex](https://img.shields.io/hexpm/v/glquic?logo=erlang&logoColor=%23bac2de&label=hex&labelColor=%23313244&color=%236E4A7E)](https://hex.pm/packages/glquic)

QUIC for Gleam, built on [erlang_quic](https://github.com/benoitc/erlang_quic)

## using

```sh
gleam add glquic
```

erlang_quic is written in Erlang, so nothing native is built. It needs Erlang/OTP 26 or later

each connection sends its events, including those of all its streams, as messages to the process that owns it: the one that connected, or the one a listener's handler returned

### client

```gleam
import glquic

pub fn main() {
  let options = glquic.client_options(alpn: ["echo"])
  let assert Ok(connection) =
    glquic.connect(to: "localhost", on: 4433, with: options, timeout: 5000)

  let assert Ok(stream) = glquic.open_stream(connection)
  let assert Ok(Nil) = glquic.send_and_finish(stream, <<"Hello, Joe!">>)

  case glquic.receive(within: 5000) {
    Ok(glquic.Data(data:, ..)) -> echo data
    _ -> panic as "no reply"
  }
}
```

### server

```gleam
import gleam/erlang/process
import glquic

pub fn main() {
  let options =
    glquic.server_options(
      alpn: ["echo"],
      certificate: "cert.pem",
      private_key: "key.pem",
    )
  let assert Ok(_listener) =
    glquic.listen(on: 4433, with: options, handler: fn(_connection) {
      process.spawn(echo_loop)
    })
  process.sleep_forever()
}

fn echo_loop() -> Nil {
  case glquic.receive(within: 60_000) {
    Ok(glquic.Data(stream:, data:, fin: True)) -> {
      let _ = glquic.send_and_finish(stream, data)
      echo_loop()
    }
    Ok(glquic.Data(stream:, data:, fin: False)) -> {
      let _ = glquic.send(stream, data)
      echo_loop()
    }
    Ok(glquic.ConnectionClosed(..)) | Error(Nil) -> Nil
    Ok(_) -> echo_loop()
  }
}
```

events can also be added to a selector with `glquic.select`, for use in actors

## contributing

see [CONTRIBUTING.md](CONTRIBUTING.md) for requirements and getting started