Yggdrasil
Yggdrasil v6.0.3

View Source Yggdrasil.Registry (Yggdrasil v6.0.3)

Yggdrasil Registry for adapters, transformers and backends aliases.

Link to this section Summary

Types

name()

Registry alias.

type()

Registry type.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_adapter_module(name)

Gets adapter module.

get_adapter_node(name)

Gets adapter node by name.

get_backend_module(name)

Gets backend module.

get_full_channel(channel)

Gets full channel given a channel.

get_publisher_module(name)

Gets publisher module.

get_subscriber_module(name)

Gets subscriber module.

get_transformer_module(name)

Gets transformer module.

register_adapter(name, module)

Registers an adapter.

register_backend(name, module)

Registers a backend.

register_transformer(name, module)

Registers a transformer.

start_link(_)

Link to this section Types

Link to this type

name()

View Source 
@type name() :: atom()

Registry alias.

Link to this type

type()

View Source 
@type type() :: :transformer | :backend | :subscriber | :publisher | :adapter

Registry type.

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get_adapter_module(name)

View Source 
@spec get_adapter_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets adapter module.

Link to this function

get_adapter_node(name)

View Source 
@spec get_adapter_node(name() | module()) :: {:ok, node()} | {:error, binary()}

Gets adapter node by name.

Link to this function

get_backend_module(name)

View Source 
@spec get_backend_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets backend module.

Link to this function

get_full_channel(channel)

View Source 
@spec 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 
@spec get_publisher_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets publisher module.

Link to this function

get_subscriber_module(name)

View Source 
@spec get_subscriber_module(name() | module()) :: {:ok, module()} | {:error, binary()}

Gets subscriber module.

Link to this function

get_transformer_module(name)

View Source 
@spec get_transformer_module(name() | module()) ::
  {:ok, module()} | {:error, binary()}

Gets transformer module.

Link to this function

register_adapter(name, module)

View Source 
@spec register_adapter(name(), module()) :: :ok

Registers an adapter.

Link to this function

register_backend(name, module)

View Source 
@spec register_backend(name(), module()) :: :ok

Registers a backend.

Link to this function

register_transformer(name, module)

View Source 
@spec register_transformer(name(), module()) :: :ok

Registers a transformer.

Link to this function

start_link(_)

View Source 
@spec start_link([Supervisor.option() | Supervisor.init_option()]) ::
  Supervisor.on_start()