Yggdrasil

v4.1.3

Yggdrasil

Yggdrasil v4.1.3 Yggdrasil.Registry View Source

Yggdrasil Registry for adapters, transformers and backends aliases.

Link to this section Summary

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

get_adapter_module(name)

Gets the adapter module for a name

get_backend_module(name)

Gets the backend module for a name

get_full_channel(channel)

Gets full channel from the current channel

get_publisher_module(name)

Gets the publisher module for a name

get_subscriber_module(name)

Gets the subscriber module for a name

get_transformer_module(name)

Gets the transformer module for a name

register_adapter(name, module)

Registers an adapter module as name

register_backend(name, module)

Registers a backend module as a name

register_transformer(name, module)

Registers a transformer module as a name

start_link(options \\ [])

Starts a registry with some optional options

stop(agent)

Stops a registry with optionals reason and timeout

Link to this section Functions

Link to this function child_spec(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 
get_adapter_module(atom() | module()) :: {:ok, module()} | {:error, term()}

Gets the adapter module for a name.

Link to this function get_backend_module(name) View Source 
get_backend_module(atom() | module()) :: {:ok, module()} | {:error, term()}

Gets the backend module for a name.

Link to this function get_full_channel(channel) View Source 
get_full_channel(channel :: Yggdrasil.Channel.t()) ::
  {:ok, Yggdrasil.Channel.t()} | {:error, term()}

Gets full channel from the current channel.

Link to this function get_publisher_module(name) View Source 
get_publisher_module(atom() | module()) :: {:ok, module()} | {:error, term()}

Gets the publisher module for a name.

Link to this function get_subscriber_module(name) View Source 
get_subscriber_module(atom() | module()) :: {:ok, module()} | {:error, term()}

Gets the subscriber module for a name.

Link to this function get_transformer_module(name) View Source 
get_transformer_module(atom() | module()) :: {:ok, module()} | {:error, term()}

Gets the transformer module for a name.

Link to this function register_adapter(name, module) View Source 
register_adapter(atom(), atom() | module()) :: :ok | :error

Registers an adapter module as name.

Link to this function register_backend(name, module) View Source 
register_backend(atom(), module()) :: :ok | :error

Registers a backend module as a name.

Link to this function register_transformer(name, module) View Source 
register_transformer(atom(), module()) :: :ok | :error

Registers a transformer module as a name.

Link to this function start_link(options \\ []) View Source 
start_link(Agent.options()) :: Agent.on_start()

Starts a registry with some optional options

Link to this function stop(agent) View Source

Stops a registry with optionals reason and timeout.