API Reference Yggdrasil v6.0.2

modules

Modules

Yggdrasil is an immense mythical tree that connects the nine worlds in Norse cosmology.

This module defines a generalization of an adapter (for adapter creation refer to Yggdrasil.Subscriber.Adapter and Yggdrasil.Publisher.Adapter behaviour).

Yggdrasil bridge adapter. The name of the channel is a valid remote Yggdrasil.Channel e.g

This module generates supervised remote subscribers.

This module defines a bridge remote subscriber.

Yggdrasil adapter for Elixir. The name of the channel can be any arbitrary term e.g

Backend behaviour that defines how to subscribe, unsubscribe and publish as well as send messages of connection and disconnection to subscribers.

Distributor backend to subscribe, unsubscribe and publish messages. Uses Phoenix.PubSub for message distribution.

Channel struct definition.

This module defines the available config variables for Yggdrasil.

Publisher pool of processes.

Publisher adapter behaviour.

Yggdrasil bridge publisher adapter. The name of the channel can be any arbitrary term e.g

Yggdrasil publisher adapter for Elixir. The name of the channel can be any arbitrary term e.g

Generator of publisher pools.

Yggdrasil Registry for adapters, transformers and backends aliases.

Subscriber adapter behaviour.

Yggdrasil bridge subscriber adapter. The name of the channel is a valid remote Yggdrasil.Channel e.g

Yggdrasil subscriber adapter for Elixir. The name of the channel can be any arbitrary term e.g

Supervisor to generate distributors on demand.

Manages subscription to a channel.

A server to distribute the messages.

Transformer behaviour that defines how to decode and encode messages from a Yggdrasil.Channel.

Does not do anything to the messages and sends them as is.

JSON Yggdrasil transformer using the library Jason.