Common GenServer patterns and utilities to reduce code duplication. Provides standardized handlers for common operations like state retrieval, metrics collection, and configuration management.
Summary
Functions
Ensures a named process is running. Starts it via start_fun if not found.
Standard handler for getting specific state fields.
Standard handler for getting metrics from state.
Standard handler for getting state information.
Standard handler for getting status information.
Standard handler for resetting metrics.
Standard handler for updating configuration.
Utility to increment a metric counter.
Initialize default state with common fields.
Splits a keyword list into GenServer server options and init args.
Utility to update a metric value.
Functions
Ensures a named process is running. Starts it via start_fun if not found.
The start_fun is a zero-arity function that should return {:ok, pid}.
Examples
ensure_started(MyServer, fn -> MyServer.start_link(name: MyServer) end)Standard handler for getting specific state fields.
Standard handler for getting metrics from state.
Standard handler for getting state information.
Standard handler for getting status information.
Standard handler for resetting metrics.
Standard handler for updating configuration.
Utility to increment a metric counter.
Initialize default state with common fields.
Splits a keyword list into GenServer server options and init args.
Server options (:name, :timeout, :debug, :spawn_opt) are
separated from the remaining application-specific options.
Examples
iex> split_server_opts(name: MyServer, timeout: 5000, foo: :bar)
{[name: MyServer, timeout: 5000], [foo: :bar]}
iex> split_server_opts(%{name: MyServer})
{[name: MyServer], []}Utility to update a metric value.