SuperWorker.Supervisor (SuperWorker v0.3.5)
View SourceDocumentation for SuperWorker.Supervisor.
This module is new model supervisor.
Better support for modern applications.
That is an all-in-one supervisor for Elixir application.
Easy to identify the worker for directly communicating with it.
New supervisor supports the following features:
- Group processes
- Chain processes
- Standalone processes
Group processes
Group processes are a set of processes that are started together. If one of the processes is crashed, depending on the restart strategy of group, only that process or all the processes will be restarted. Each group has a separated restart strategy.
Chain processes
Chain processes are a set of processes that support for chain processing. Each process in a chain has order to process data. The output of the previous process is passed to the next process.
Standalone processes
Standalone processes are independent processes that are started separately. Each process has its own restart strategy.
All type of processes can be started in parallel & can be stopped individually or in a group.
The restart strategy only works when the process is crashed, for normal exit, shutdown, or terminated it will be ignored.
Examples
# Start a supervisor with 2 partitions & 2 groups:
alias SuperWorker.Supervisor, as: Sup
# Config for supervisor
opts = [id: :sup1, num_partitions: 2, link: false]
# Start supervisor
Sup.start_with_config(opts)
# Add group in runtime, you also can add group in config.
Sup.add_group(:sup1, [id: :group1, restart_strategy: :one_for_all])
Sup.add_group_worker(:sup1, :group1, {Dev, :task, [15]}, [id: :g1_1])
Sup.add_group(:sup1, [id: :group2, restart_strategy: :one_for_one])
Sup.add_group_worker(:sup1, :group2, fn ->
receive do
{:ping, ref, from} ->
send(from, {:pong, ref})
msg ->
:ok
end
end, [id: :g2_2])
ref = make_ref()
Sup.send_to_group_worker(:sup1, :group2, :g2_2, {:ping, ref, self()})
receive do
{:pong, ^ref} ->
:ok
endSupervisor can add directly to other supervisor or by add config to config file or self start with start/start_link/startwith_config function.
Summary
Functions
Add a chain to the supervisor.
Chain's options follow docs in Chain module.
Add a worker to the chain in supervisor.
Add a group to the supervisor.
Group's options follow docs in Group module.
Add a worker to a group in the supervisor.
Function's options follow Worker module.
Support worker is function (mfa, anonymous function) or GenServer
Add a standalone worker process to the supervisor. function for start worker can be a function or a {module, function, arguments} or a GenServer. Standalone worker is run independently from other workers follow :one_to_one strategy. If worker crashes, it will check the restart strategy of worker then act accordingly.
Send data to all workers in a group.
Send data to all workers in current group of worker. Using for communite between workers in the same group.
Returns a specification to start this module under a supervisor.
count workers in chain
count workers in group
get current group id of worker.
Get supervisor id in current process (not support for GenServer worker).
get pid of chain worker
get pid of group worker.
get pid of standalone worker
group is existed
remove chain.
remove a worker from chain.
remove group
remove a worker out of group
Remove standalone worker from supervisor.
Restart all workers in group
Restart a worker in group
Check if supervisor is running.
Send data to the entry worker in the chain. If chain doesn't has any worker, it will be dropped.
Send data to a random worker in the group.
Send data to a worker in the group.
Send data to other worker in the same group.
Send data to a random worker in the same group.
Send data directly to the worker standalone in the supervisor.
Start supervisor run as independent process with default options.
Start supervisor as independent process (no link process).
Work like start_link/1 with default options.
start_link for using supervisor as child in other supervisor or link to current process.
Start supervisor with configurations (Keyword). For run standalone, please set option :link to false. For link to other process (not current process), please set link to pid of that process. result format: {:ok, pid} or {:error, reason}
Stop supervisor. Type of shutdown is using for reason of exit in Process.exit function. Type of shutdown
Types
@type t() :: %SuperWorker.Supervisor{ id: atom(), link: boolean(), num_partitions: pos_integer(), partitions: %{required(pos_integer()) => pid()}, report_to: [pid() | {atom(), pid()}], table: nil }
Functions
@spec add_chain(atom(), list(), non_neg_integer()) :: {:ok, atom()} | {:error, any()}
Add a chain to the supervisor.
Chain's options follow docs in Chain module.
@spec add_chain_worker( atom(), atom(), {module(), atom(), list()} | fun() | module() | {module(), list()}, list(), non_neg_integer() ) :: {:ok, atom()} | {:error, any()}
Add a worker to the chain in supervisor.
@spec add_group(atom(), list(), non_neg_integer()) :: {:ok, atom()} | {:error, any()}
Add a group to the supervisor.
Group's options follow docs in Group module.
@spec add_group_worker( atom(), atom(), {module(), atom(), list()} | fun() | module() | {module(), list()}, list(), non_neg_integer() ) :: {:ok, atom()} | {:error, any()}
Add a worker to a group in the supervisor.
Function's options follow Worker module.
Support worker is function (mfa, anonymous function) or GenServer
@spec add_standalone_worker( atom(), {module(), atom(), list()} | fun() | module() | {module(), list()}, list(), non_neg_integer() ) :: {:ok, atom()} | {:error, any()}
Add a standalone worker process to the supervisor. function for start worker can be a function or a {module, function, arguments} or a GenServer. Standalone worker is run independently from other workers follow :one_to_one strategy. If worker crashes, it will check the restart strategy of worker then act accordingly.
@spec broadcast_to_group(atom(), atom(), any(), non_neg_integer()) :: :ok | {:error, any()}
Send data to all workers in a group.
Send data to all workers in current group of worker. Using for communite between workers in the same group.
Returns a specification to start this module under a supervisor.
See Supervisor.
@spec count_workers_in_chain(atom(), any(), non_neg_integer()) :: :ok | {:error, any()}
count workers in chain
@spec count_workers_in_group(atom(), any(), non_neg_integer()) :: :ok | {:error, any()}
count workers in group
@spec get_my_group() :: atom() | nil
get current group id of worker.
@spec get_my_supervisor() :: atom() | nil
Get supervisor id in current process (not support for GenServer worker).
@spec get_pid_chain_worker(atom(), any(), any(), non_neg_integer()) :: {:ok, any()} | {:error, any()}
get pid of chain worker
get pid of group worker.
@spec get_pid_standalone_worker(atom(), any(), non_neg_integer()) :: {:ok, pid()} | {:error, term()}
get pid of standalone worker
@spec group_exists?(atom(), any(), non_neg_integer()) :: boolean() | {:error, any()}
group is existed
@spec remove_chain(atom(), any(), non_neg_integer()) :: {:ok, any()} | {:error, any()}
remove chain.
@spec remove_chain_worker(atom(), any(), any(), non_neg_integer()) :: {:ok, any()} | {:error, any()}
remove a worker from chain.
@spec remove_group(atom(), any(), non_neg_integer()) :: :ok | {:error, any()}
remove group
@spec remove_group_worker(atom(), any(), any(), non_neg_integer()) :: :ok | {:error, any()}
remove a worker out of group
@spec remove_standalone_worker(atom(), any(), non_neg_integer()) :: :ok | {:error, term()}
Remove standalone worker from supervisor.
@spec restart_group(atom(), any(), non_neg_integer()) :: {:ok, atom()} | {:error, any()}
Restart all workers in group
@spec restart_group_worker(atom(), any(), any(), non_neg_integer()) :: {:ok, atom()} | {:error, any()}
Restart a worker in group
Check if supervisor is running.
Send data to the entry worker in the chain. If chain doesn't has any worker, it will be dropped.
@spec send_to_group_random(atom(), any(), any(), non_neg_integer()) :: :ok | {:error, any()}
Send data to a random worker in the group.
Send data to a worker in the group.
Send data to other worker in the same group.
Send data to a random worker in the same group.
@spec send_to_standalone_worker(atom(), any(), any(), non_neg_integer()) :: :ok | {:error, term()}
Send data directly to the worker standalone in the supervisor.
Start supervisor run as independent process with default options.
Start supervisor as independent process (no link process).
Work like start_link/1 with default options.
start_link for using supervisor as child in other supervisor or link to current process.
@spec start_with_config( id: atom(), link: boolean() | pid(), num_partitions: integer(), report_to: list() ) :: {:ok, pid()} | {:error, any()}
Start supervisor with configurations (Keyword). For run standalone, please set option :link to false. For link to other process (not current process), please set link to pid of that process. result format: {:ok, pid} or {:error, reason}
@spec stop(atom(), shutdown_type :: atom(), timeout :: non_neg_integer()) :: {:ok, atom()} | {:error, any()}
Stop supervisor. Type of shutdown is using for reason of exit in Process.exit function. Type of shutdown:
:normalsupervisor will send a message to worker for graceful shutdown. Not support for spawn process by function.:killsupervisor will kill worker.