Fledex.Animation.Coordinator behaviour (fledex v0.5.0)

View Source

Summary

Types

config_t()

@type config_t() :: %{
  optional(:type) => :coordinator,
  optional(:options) => keyword(),
  optional(:func) => (any(), map(), keyword() -> keyword())
}

Callbacks

config atom, atom, config_t

@callback config(atom(), atom(), config_t()) :: :ok

shutdown(atom, atom)

@callback shutdown(atom(), atom()) :: :ok

start_link(strip_name, coordinator_name, configs)

@callback start_link(
  strip_name :: atom(),
  coordinator_name :: atom(),
  configs :: keyword()
) ::
  GenServer.on_start()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

config(strip_name, animation_name, config)

@spec config(atom(), atom(), config_t()) :: :ok

default_func(broadcast_state, context, options)

@spec default_func(any(), map(), keyword()) :: keyword()

shutdown(strip_name, coordinator_name)

@spec shutdown(atom(), atom()) :: :ok

start_link(strip_name, animation_name, configs)

@spec start_link(
  strip_name :: atom(),
  coordinator_name :: atom(),
  configs :: keyword()
) ::
  GenServer.on_start()