View Source Kungfuig behaviour (Kungfuig v1.0.0)

The behaviour defining the dynamic config provider.

Kungfuig provides a plugagble drop-in support for live configurations.

Examples

Kungfuig.Supervisor.start_link()
Kungfuig.config()
#⇒ %{env: %{kungfuig: []}, system: %{}}

Kungfuig.config(:env)
#⇒ %{kungfuig: []}

Application.put_env(:kungfuig, :foo, 42)
Kungfuig.config(:env)
#⇒ %{kungfuig: [foo: 42]}

The configuration is frequently updated.

Summary

Types

callback()

The callback to be used for subscibing to config updates.

config()

The config map to be updated and exposed through callback

option()

The option that can be passed to start_link/1 function

t()

The start_link/1 function wrapping the GenServer.start_link/3

Callbacks

start_link(opts)

update_config(state)

The actual implementation to update the config

Functions

%Kungfuig{}

The config that is manages by this behaviour is a simple map

config(which \\ :!, supervisor \\ Kungfuig.Supervisor)

Types

callback()

@type callback() ::
  {module(), atom()}
  | (config() -> :ok)
  | {GenServer.name() | pid(), {:call | :cast | :info, atom()}}

The callback to be used for subscibing to config updates.

Might be an anonymous function, an {m, f} tuple accepting a single argument, or a process identifier accepting call, cast or simple message (:info.)

config()

@type config() :: %{required(atom()) => term()}

The config map to be updated and exposed through callback

option()

@type option() ::
  {:name, GenServer.name()}
  | {:callback, callback()}
  | {:interval, non_neg_integer()}
  | {:anonymous, boolean()}
  | {:start_options, [GenServer.option()]}
  | {atom(), term()}

The option that can be passed to start_link/1 function

t()

@type t() :: %Kungfuig{
  __meta__: [option()],
  __start_options__: [],
  __previous__: config(),
  state: config()
}

The start_link/1 function wrapping the GenServer.start_link/3

Callbacks

start_link(opts)

@callback start_link(opts :: [option()]) :: GenServer.on_start()

update_config(state)

@callback update_config(state :: t()) :: config()

The actual implementation to update the config

Functions

%Kungfuig{}

(struct)

The config that is manages by this behaviour is a simple map

config(which \\ :!, supervisor \\ Kungfuig.Supervisor)

@spec config(which :: atom() | [atom()], supervisor :: Supervisor.supervisor()) :: t()