API Reference Abyss v0.1.0

Abyss is a modern, pure Elixir UDP socket server

Abyss.Handler defines the behaviour required of the application layer of a Abyss server. When starting a Abyss server, you must pass the name of a module implementing this behaviour as the handler_module parameter. Abyss will then use the specified module to handle each connection that is made to the server.

Logging conveniences for Abyss servers

Encapsulates the configuration of a Abyss server instance

The following telemetry spans are emitted by abyss

This module describes the behaviour required for Abyss to interact with low-level sockets. It is largely internal to Abyss, however users are free to implement their own versions of this behaviour backed by whatever underlying transport they choose. Such a module can be used in Abyss by passing its name as the transport_module option when starting up a server, as described in Abyss.

Defines a Abyss.Transport implementation based on clear UDP sockets as provided by Erlang's :gen_udp module. For the most part, users of Thousand Island will only ever need to deal with this module via transport_options passed to Abyss at startup time. A complete list of such options is defined via the :gen_udp.open_option/0 type. This list can be somewhat difficult to decipher; by far the most common value to pass to this transport is the following