View Source Yggdrasil.Registry (Yggdrasil v6.0.2)

Yggdrasil Registry for adapters, transformers and backends aliases.

Link to this section Summary

Types

Registry alias.

Registry type.

Functions

Returns a specification to start this module under a supervisor.

Gets adapter module.

Gets adapter node by name.

Gets backend module.

Gets full channel given a channel.

Gets publisher module.

Gets subscriber module.

Gets transformer module.

Registers an adapter.

Registers a backend.

Registers a transformer.

Link to this section Types

Specs

name() :: atom()

Registry alias.

Specs

type() :: :transformer | :backend | :subscriber | :publisher | :adapter

Registry type.

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get_adapter_module(name)

View Source

Specs

get_adapter_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets adapter module.

Specs

get_adapter_node(name() | module()) :: {:ok, node()} | {:error, binary()}

Gets adapter node by name.

Link to this function

get_backend_module(name)

View Source

Specs

get_backend_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets backend module.

Link to this function

get_full_channel(channel)

View Source

Specs

get_full_channel(Yggdrasil.Channel.t()) ::
  {:ok, Yggdrasil.Channel.t()} | {:error, binary()}

Gets full channel given a channel.

Link to this function

get_publisher_module(name)

View Source

Specs

get_publisher_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets publisher module.

Link to this function

get_subscriber_module(name)

View Source

Specs

get_subscriber_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets subscriber module.

Link to this function

get_transformer_module(name)

View Source

Specs

get_transformer_module(name() | module()) ::
  {:ok, module()} | {:error, binary()}

Gets transformer module.

Link to this function

register_adapter(name, module)

View Source

Specs

register_adapter(name(), module()) :: :ok

Registers an adapter.

Link to this function

register_backend(name, module)

View Source

Specs

register_backend(name(), module()) :: :ok

Registers a backend.

Link to this function

register_transformer(name, module)

View Source

Specs

register_transformer(name(), module()) :: :ok

Registers a transformer.

Specs