yggdrasil v4.0.0 API Reference
Modules
This module defines a generalization of an adapter (for adapter creation
refer to Yggdrasil.Subscriber.Adapter
and Yggdrasil.Publisher.Adapter
behaviour)
Yggdrasil adapter for Elixir. The name of the channel can be any arbitrary term e.g
Module that defines an Yggdrasil
application
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
Publisher pool of processes
Publisher adapter behaviour
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
This module defines the available settings for Yggdrasil
Subscriber adapter behaviour
Yggdrasil subscriber adapter for Elixir. The name of the channel can be any arbitrary term e.g
Supervisor for Yggdrasil.Subscriber.Manager
,
Yggdrasil.Subscriber.Adapter
and Yggdrasil.Subscriber.Publisher
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