Exshome - Elixir Smart Home v0.1.7

View Source Exshome.Dependency.GenServerDependency behaviour (Exshome - Elixir Smart Home v0.1.7)

This module stores generic API for GenServer based dependencies.

Link to this section Summary

Callbacks

handle_call(request, from, state)
handle_dependency_change(t)
handle_event(event_message, t)
handle_info(message, t)
on_init(t)
parse_opts(map)
update_value(t, value)

Functions

call(server, message)
child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_pid(server)

See ExshomeTest.Hooks.Dependency.get_pid/1.

get_value(server)
handle_dependency_change(state)
handle_dependency_info(arg, state)
modules(app)
start_link(opts)
subscribe_to_dependencies(state, dependencies)
subscribe_to_events(state, events)
update_data(state, update_fn)
update_value(state, value)
validate_config!(config)

Validates configuration for the dependency and raises if it is invalid. Available configuration options: :name (required) - name of the dependency :dependencies (default []) - dependencies list :events (default []) - events to subscribe, where key is a module, and value is a topic

validate_module!(env, bytecode)

Link to this section Callbacks

Link to this callback

handle_call(request, from, state)

View Source (optional) 
@callback handle_call(
  request :: term(),
  GenServer.from(),
  state :: Exshome.Dependency.GenServerDependency.DependencyState.t()
) ::
  {:reply, reply, new_state}
  | {:reply, reply, new_state, timeout() | :hibernate | {:continue, term()}}
  | {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate | {:continue, term()}}
  | {:stop, reason, reply, new_state}
  | {:stop, reason, new_state}
when reply: term(),
     new_state: Exshome.Dependency.GenServerDependency.DependencyState.t(),
     reason: term()
Link to this callback

handle_dependency_change(t)

View Source 
@callback handle_dependency_change(
  Exshome.Dependency.GenServerDependency.DependencyState.t()
) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this callback

handle_event(event_message, t)

View Source 
@callback handle_event(
  Exshome.Event.event_message(),
  Exshome.Dependency.GenServerDependency.DependencyState.t()
) :: Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this callback

handle_info(message, t)

View Source (optional) 
@callback handle_info(
  message :: any(),
  Exshome.Dependency.GenServerDependency.DependencyState.t()
) ::
  {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate | {:continue, term()}}
  | {:stop, reason :: term(), new_state}
when new_state: Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this callback

on_init(t)

View Source 
@callback on_init(Exshome.Dependency.GenServerDependency.DependencyState.t()) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this callback

parse_opts(map)

View Source 
@callback parse_opts(map()) :: any()
Link to this callback

update_value(t, value)

View Source 
@callback update_value(
  Exshome.Dependency.GenServerDependency.DependencyState.t(),
  value :: any()
) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()

Link to this section Functions

Link to this function

call(server, message)

View Source 
@spec call(GenServer.server(), any()) :: any()
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_pid(server)

View Source 
@spec get_pid(atom() | pid()) :: pid() | nil

See ExshomeTest.Hooks.Dependency.get_pid/1.

Link to this function

get_value(server)

View Source 
@spec get_value(GenServer.server()) :: any()
Link to this function

handle_dependency_change(state)

View Source 
@spec handle_dependency_change(
  Exshome.Dependency.GenServerDependency.DependencyState.t()
) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this function

handle_dependency_info(arg, state)

View Source 
@spec handle_dependency_info(
  any(),
  Exshome.Dependency.GenServerDependency.DependencyState.t()
) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this function

modules(app)

View Source 
@spec modules(app :: atom()) :: MapSet.t(Exshome.Dependency.dependency())
Link to this function

start_link(opts)

View Source 
@spec start_link(map()) :: GenServer.on_start()
Link to this function

subscribe_to_dependencies(state, dependencies)

View Source 
@spec subscribe_to_dependencies(
  Exshome.Dependency.GenServerDependency.DependencyState.t(),
  Enumerable.t()
) :: Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this function

subscribe_to_events(state, events)

View Source 
@spec subscribe_to_events(
  Exshome.Dependency.GenServerDependency.DependencyState.t(),
  Enumerable.t()
) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this function

update_data(state, update_fn)

View Source 
@spec update_data(
  Exshome.Dependency.GenServerDependency.DependencyState.t(),
  (any() -> any())
) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this function

update_value(state, value)

View Source 
@spec update_value(
  Exshome.Dependency.GenServerDependency.DependencyState.t(),
  value :: any()
) ::
  Exshome.Dependency.GenServerDependency.DependencyState.t()
Link to this function

validate_config!(config)

View Source 
@spec validate_config!(Keyword.t()) :: keyword()

Validates configuration for the dependency and raises if it is invalid. Available configuration options: :name (required) - name of the dependency :dependencies (default []) - dependencies list :events (default []) - events to subscribe, where key is a module, and value is a topic

Link to this function

validate_module!(env, bytecode)

View Source 
@spec validate_module!(Macro.Env.t(), String.t()) :: keyword()