SuperWorker.Supervisor.Chain (SuperWorker v0.3.6)

View Source

Documentation for SuperWorker.Supervisor.Chain.

Summary

Types

t()

Functions

add_worker(chain, worker)
check_options(options)
count_workers(chain)
get_all_workers(chain)
get_worker(chain, worker_id)
kill_worker(chain, worker_id)
remove_worker(chain, worker_id)
restart_all_workers(chain)
restart_worker(chain, worker_id)
worker_exists?(chain, worker_id)

Types

t()

@type t() :: %SuperWorker.Supervisor.Chain{
  finished_callback: nil | {:fun, fun()} | {module(), atom(), [any()]},
  id: any(),
  partition_pid: term(),
  queue_length: non_neg_integer(),
  restart_strategy: atom(),
  send_type: :broadcast | :random | :partition | :round_robin,
  supervisor: atom(),
  table: atom()
}

Functions

add_worker(chain, worker)

@spec add_worker(t(), SuperWorker.Supervisor.Worker.t()) ::
  {:error, :already_exists} | {:ok, t()}

check_options(options)

@spec check_options([atom() | keyword()]) ::
  {:error, atom() | {atom(), any()}} | {:ok, t()}

count_workers(chain)

get_all_workers(chain)

@spec get_all_workers(t()) :: {:ok, [SuperWorker.Supervisor.Worker.t()]}

get_worker(chain, worker_id)

@spec get_worker(t(), any()) ::
  {:error, :worker_not_found} | {:ok, SuperWorker.Supervisor.Worker.t()}

kill_worker(chain, worker_id)

@spec kill_worker(t(), any()) :: {:error, any()} | {:ok, t()}

remove_worker(chain, worker_id)

@spec remove_worker(t(), any()) :: true

restart_all_workers(chain)

@spec restart_all_workers(t()) :: {:ok, t()}

restart_worker(chain, worker_id)

@spec restart_worker(t(), any()) :: {:error, any()} | {:ok, t()}

worker_exists?(chain, worker_id)

@spec worker_exists?(t(), any()) :: boolean()