package atacama
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c8cc66d369f19b81309e536ca02673dc4db60c591c6df0015ab621175f087405
sha512=2730d92f558b56bbbf363e1d6ebde41c6d88b2b4ac1c245be92c97f61fc38efbe27a4a886ba7f1d34ef3933c3a532d7bfbabb724316997de18f5c0d4cae6916d
Description
Atacama is a modern, pure OCaml socket pool for Riot inspired by Thousand Island. It aims to be easy to understand and reason about, while also being at least as stable and performant as the alternatives.
README
Atacama
Atacama is a modern, pure OCaml socket pool for Riot inspired by Thousand Island. It aims to be easy to understand and reason about, while also being at least as stable and performant as the alternatives.
Getting Started
opam install atacama
Usage
To start a Atacama server, you just specify a port to bind to, and a module that will handle the connections.
let (Ok pid) = Atacama.start_link ~port:2112 (module Echo) initial_state in
In this case, our Echo
handler looks like this:
module Echo = struct
open Atacama.Handler
include Atacama.Handler.Default
type state = int
let handle_data data socket state =
Logger.info (fun f -> f "[%d] echo: %s" state (Bigstringaf.to_string data));
let (Ok _bytes) = Atacama.Socket.send socket data in
Continue (state+1)
end
Custom lifecycle functions can be specified, but sensible defaults are available in the Atacama.Handler.Default
module that you can include to get started quickly.
Custom Transports
When starting a Atacama server, we can also specify a transport module.
let (Ok pid) = Atacama.start_link
~port:2112
~transport_module:(module Custom_transport)
(module Echo) in
A transport is a module that implements Atacama.Transport.Intf
, which defines how to listen, connect, and accept sockets, how to handshake new connections, and how to send and receive data.
Clear Tcp sockets are provided and used by default when starting a Atacama server.